Class BuildConfig (2.46.0)

publicfinalclass BuildConfigextendsGeneratedMessageV3implementsBuildConfigOrBuilder

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

Protobuf type google.cloud.functions.v2beta.BuildConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BuildConfig

Implements

BuildConfigOrBuilder

Inherited Members

publicstaticfinalintBUILD_FIELD_NUMBER

publicstaticfinalintDOCKER_REGISTRY_FIELD_NUMBER

publicstaticfinalintDOCKER_REPOSITORY_FIELD_NUMBER

publicstaticfinalintENTRY_POINT_FIELD_NUMBER

publicstaticfinalintENVIRONMENT_VARIABLES_FIELD_NUMBER

publicstaticfinalintRUNTIME_FIELD_NUMBER

publicstaticfinalintSOURCE_FIELD_NUMBER

publicstaticfinalintSOURCE_PROVENANCE_FIELD_NUMBER

publicstaticfinalintWORKER_POOL_FIELD_NUMBER

publicstaticBuildConfiggetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticBuildConfig.BuildernewBuilder()

publicstaticBuildConfig.BuildernewBuilder(BuildConfigprototype)

publicstaticBuildConfigparseDelimitedFrom(InputStreaminput)

publicstaticBuildConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticBuildConfigparseFrom(byte[]data)

publicstaticBuildConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticBuildConfigparseFrom(ByteStringdata)

publicstaticBuildConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticBuildConfigparseFrom(CodedInputStreaminput)

publicstaticBuildConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticBuildConfigparseFrom(InputStreaminput)

publicstaticBuildConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticBuildConfigparseFrom(ByteBufferdata)

publicstaticBuildConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<BuildConfig>parser()

publicbooleancontainsEnvironmentVariables(Stringkey)

User-provided build-time environment variables for the function

map<string, string> environment_variables = 6;

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicStringgetBuild()

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

string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

publicByteStringgetBuildBytes()

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

string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

publicBuildConfiggetDefaultInstanceForType()

publicBuildConfig.DockerRegistrygetDockerRegistry()

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.

.google.cloud.functions.v2beta.BuildConfig.DockerRegistry docker_registry = 10;

publicintgetDockerRegistryValue()

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.

.google.cloud.functions.v2beta.BuildConfig.DockerRegistry docker_registry = 10;

publicStringgetDockerRepository()

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

string docker_repository = 7 [(.google.api.resource_reference) = { ... }

publicByteStringgetDockerRepositoryBytes()

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

string docker_repository = 7 [(.google.api.resource_reference) = { ... }

publicStringgetEntryPoint()

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.

string entry_point = 3;

publicByteStringgetEntryPointBytes()

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.

string entry_point = 3;

publicMap<String,String>getEnvironmentVariables()

Use #getEnvironmentVariablesMap() instead.

publicintgetEnvironmentVariablesCount()

User-provided build-time environment variables for the function

map<string, string> environment_variables = 6;

publicMap<String,String>getEnvironmentVariablesMap()

User-provided build-time environment variables for the function

map<string, string> environment_variables = 6;

publicStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)

User-provided build-time environment variables for the function

map<string, string> environment_variables = 6;

publicStringgetEnvironmentVariablesOrThrow(Stringkey)

User-provided build-time environment variables for the function

map<string, string> environment_variables = 6;

publicParser<BuildConfig>getParserForType()

GeneratedMessageV3.getParserForType()

publicStringgetRuntime()

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.

string runtime = 2;

publicByteStringgetRuntimeBytes()

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.

string runtime = 2;

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicSourcegetSource()

The location of the function source code.

.google.cloud.functions.v2beta.Source source = 4;

publicSourceOrBuildergetSourceOrBuilder()

The location of the function source code.

.google.cloud.functions.v2beta.Source source = 4;

publicSourceProvenancegetSourceProvenance()

Output only. A permanent fixed identifier for source.

.google.cloud.functions.v2beta.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicSourceProvenanceOrBuildergetSourceProvenanceOrBuilder()

Output only. A permanent fixed identifier for source.

.google.cloud.functions.v2beta.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicStringgetWorkerPool()

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.

string worker_pool = 5 [(.google.api.resource_reference) = { ... }

publicByteStringgetWorkerPoolBytes()

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.

string worker_pool = 5 [(.google.api.resource_reference) = { ... }

publicbooleanhasSource()

The location of the function source code.

.google.cloud.functions.v2beta.Source source = 4;

publicbooleanhasSourceProvenance()

Output only. A permanent fixed identifier for source.

.google.cloud.functions.v2beta.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicBuildConfig.BuildernewBuilderForType()

protectedBuildConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicBuildConfig.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)