BuildConfigArgs

data class BuildConfigArgs(val dockerRegistry: Output<BuildConfigDockerRegistry>? = null, val dockerRepository: Output<String>? = null, val entryPoint: Output<String>? = null, val environmentVariables: Output<Map<String, String>>? = null, val runtime: Output<String>? = null, val source: Output<SourceArgs>? = null, val workerPool: Output<String>? = null) : ConvertibleToJava<BuildConfigArgs>

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

Constructors

Link copied to clipboard
fun BuildConfigArgs(dockerRegistry: Output<BuildConfigDockerRegistry>? = null, dockerRepository: Output<String>? = null, entryPoint: Output<String>? = null, environmentVariables: Output<Map<String, String>>? = null, runtime: Output<String>? = null, source: Output<SourceArgs>? = null, workerPool: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): BuildConfigArgs

Properties

Link copied to clipboard

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.

Link copied to clipboard
val dockerRepository: Output<String>? = null

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'.

Link copied to clipboard
val entryPoint: Output<String>? = null

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.

Link copied to clipboard
val environmentVariables: Output<Map<String, String>>? = null

User-provided build-time environment variables for the function

Link copied to clipboard
val runtime: Output<String>? = null

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.

Link copied to clipboard
val source: Output<SourceArgs>? = null

The location of the function source code.

Link copied to clipboard
val workerPool: Output<String>? = null

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-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.