Cloud Functions V2 API - Class Google::Cloud::Functions::V2::BuildConfig (v0.7.0)

Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::BuildConfig.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#build

def build() -> ::String

Returns

(::String) — Output only. The Cloud Build name of the latest successful deployment of the function.

#docker_registry

def docker_registry() -> ::Google::Cloud::Functions::V2::BuildConfig::DockerRegistry

Returns

(::Google::Cloud::Functions::V2::BuildConfig::DockerRegistry) — 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 docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

#docker_registry=

def docker_registry=(value) -> ::Google::Cloud::Functions::V2::BuildConfig::DockerRegistry

Parameter

value (::Google::Cloud::Functions::V2::BuildConfig::DockerRegistry) — 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 docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

Returns

(::Google::Cloud::Functions::V2::BuildConfig::DockerRegistry) — 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 docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

#docker_repository

def docker_repository() -> ::String

Returns

(::String) — User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, 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'.

#docker_repository=

def docker_repository=(value) -> ::String

Parameter

value (::String) — User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, 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'.

Returns

(::String) — User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, 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'.

#entry_point

def entry_point() -> ::String

Returns

(::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.

#entry_point=

def entry_point=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#environment_variables

def environment_variables() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-provided build-time environment variables for the function

#environment_variables=

def environment_variables=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — User-provided build-time environment variables for the function

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-provided build-time environment variables for the function

#runtime

def runtime() -> ::String

Returns

(::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.

#runtime=

def runtime=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#source

def source() -> ::Google::Cloud::Functions::V2::Source

Returns

(::Google::Cloud::Functions::V2::Source) — The location of the function source code.

#source=

def source=(value) -> ::Google::Cloud::Functions::V2::Source

Parameter

value (::Google::Cloud::Functions::V2::Source) — The location of the function source code.

Returns

(::Google::Cloud::Functions::V2::Source) — The location of the function source code.

#source_provenance

def source_provenance() -> ::Google::Cloud::Functions::V2::SourceProvenance

Returns

(::Google::Cloud::Functions::V2::SourceProvenance) — Output only. A permanent fixed identifier for source.

#worker_pool

def worker_pool() -> ::String

Returns

(::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-

#worker_pool=

def worker_pool=(value) -> ::String

Parameter

value (::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-

Returns

(::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-