Struct google_api_proto::google::cloud::functions::v2alpha::BuildConfig

pub struct BuildConfig {
    pub build: String,
    pub runtime: String,
    pub entry_point: String,
    pub source: Option<Source>,
    pub source_provenance: Option<SourceProvenance>,
    pub worker_pool: String,
    pub environment_variables: BTreeMap<String, String>,
    pub docker_registry: i32,
    pub docker_repository: String,
    pub service_account: String,
    pub runtime_update_policy: Option<RuntimeUpdatePolicy>,
}

Describes the Build step of the function that builds a container from the given source.

Fields

build: String

Output only. The Cloud Build name of the latest successful deployment of the function.

runtime: String

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

entry_point: String

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named “function”. For Node.js this is name of a function exported by the module specified in source_location.

source: Option<Source>

The location of the function source code.

source_provenance: Option<SourceProvenance>

Output only. A permanent fixed identifier for source.

worker_pool: String

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

environment_variables: BTreeMap<String, String>

User-provided build-time environment variables for the function

docker_registry: i32

Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry.

If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.

docker_repository: String

Repository in Artifact Registry to which the function docker image will be pushed after it is built by Cloud Build. If specified by user, it is created and managed by user with a customer managed encryption key. Otherwise, GCF will create and use a repository named ‘gcf-artifacts’ for every deployed region.

It must match the pattern projects/{project}/locations/{location}/repositories/{repository}.

Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be ‘DOCKER’.

service_account: String

Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

runtime_update_policy: Option<RuntimeUpdatePolicy>

This controls when security patches are applied to the runtime environment.

Implementations

impl BuildConfig

pub fn docker_registry(&self) -> DockerRegistry

Returns the enum value of docker_registry, or the default if the field is set to an invalid enum value.

pub fn set_docker_registry(&mut self, value: DockerRegistry)

Sets docker_registry to the provided enum value.

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuildConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BuildConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for BuildConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BuildConfig

fn eq(&self, other: &BuildConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BuildConfig