public final class BuildConfig extends com.google.protobuf.GeneratedMessageV3 implements BuildConfigOrBuilder
Describes the Build step of the function that builds a container from the given source.Protobuf type
google.cloud.functions.v2.BuildConfig| Modifier and Type | Class and Description |
|---|---|
static class |
BuildConfig.Builder
Describes the Build step of the function that builds a container from the
given source.
|
static class |
BuildConfig.DockerRegistry
Docker Registry to use for storing function Docker images.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BUILD_FIELD_NUMBER |
static int |
DOCKER_REGISTRY_FIELD_NUMBER |
static int |
DOCKER_REPOSITORY_FIELD_NUMBER |
static int |
ENTRY_POINT_FIELD_NUMBER |
static int |
ENVIRONMENT_VARIABLES_FIELD_NUMBER |
static int |
RUNTIME_FIELD_NUMBER |
static int |
SOURCE_FIELD_NUMBER |
static int |
SOURCE_PROVENANCE_FIELD_NUMBER |
static int |
WORKER_POOL_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsEnvironmentVariables(String key)
User-provided build-time environment variables for the function
|
boolean |
equals(Object obj) |
String |
getBuild()
Output only.
|
com.google.protobuf.ByteString |
getBuildBytes()
Output only.
|
static BuildConfig |
getDefaultInstance() |
BuildConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
BuildConfig.DockerRegistry |
getDockerRegistry()
Docker Registry to use for this deployment.
|
int |
getDockerRegistryValue()
Docker Registry to use for this deployment.
|
String |
getDockerRepository()
User managed repository created in Artifact Registry optionally
with a customer managed encryption key.
|
com.google.protobuf.ByteString |
getDockerRepositoryBytes()
User managed repository created in Artifact Registry optionally
with a customer managed encryption key.
|
String |
getEntryPoint()
The name of the function (as defined in source code) that will be
executed.
|
com.google.protobuf.ByteString |
getEntryPointBytes()
The name of the function (as defined in source code) that will be
executed.
|
Map<String,String> |
getEnvironmentVariables()
Deprecated.
|
int |
getEnvironmentVariablesCount()
User-provided build-time environment variables for the function
|
Map<String,String> |
getEnvironmentVariablesMap()
User-provided build-time environment variables for the function
|
String |
getEnvironmentVariablesOrDefault(String key,
String defaultValue)
User-provided build-time environment variables for the function
|
String |
getEnvironmentVariablesOrThrow(String key)
User-provided build-time environment variables for the function
|
com.google.protobuf.Parser<BuildConfig> |
getParserForType() |
String |
getRuntime()
The runtime in which to run the function.
|
com.google.protobuf.ByteString |
getRuntimeBytes()
The runtime in which to run the function.
|
int |
getSerializedSize() |
Source |
getSource()
The location of the function source code.
|
SourceOrBuilder |
getSourceOrBuilder()
The location of the function source code.
|
SourceProvenance |
getSourceProvenance()
Output only.
|
SourceProvenanceOrBuilder |
getSourceProvenanceOrBuilder()
Output only.
|
String |
getWorkerPool()
Name of the Cloud Build Custom Worker Pool that should be used to build the
function.
|
com.google.protobuf.ByteString |
getWorkerPoolBytes()
Name of the Cloud Build Custom Worker Pool that should be used to build the
function.
|
int |
hashCode() |
boolean |
hasSource()
The location of the function source code.
|
boolean |
hasSourceProvenance()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static BuildConfig.Builder |
newBuilder() |
static BuildConfig.Builder |
newBuilder(BuildConfig prototype) |
BuildConfig.Builder |
newBuilderForType() |
protected BuildConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static BuildConfig |
parseDelimitedFrom(InputStream input) |
static BuildConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BuildConfig |
parseFrom(byte[] data) |
static BuildConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BuildConfig |
parseFrom(ByteBuffer data) |
static BuildConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BuildConfig |
parseFrom(com.google.protobuf.ByteString data) |
static BuildConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BuildConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static BuildConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BuildConfig |
parseFrom(InputStream input) |
static BuildConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<BuildConfig> |
parser() |
BuildConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int BUILD_FIELD_NUMBER
public static final int RUNTIME_FIELD_NUMBER
public static final int ENTRY_POINT_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER
public static final int SOURCE_PROVENANCE_FIELD_NUMBER
public static final int WORKER_POOL_FIELD_NUMBER
public static final int ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int DOCKER_REGISTRY_FIELD_NUMBER
public static final int DOCKER_REPOSITORY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getBuild()
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) = { ... }
getBuild in interface BuildConfigOrBuilderpublic com.google.protobuf.ByteString getBuildBytes()
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) = { ... }
getBuildBytes in interface BuildConfigOrBuilderpublic String getRuntime()
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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string runtime = 2;getRuntime in interface BuildConfigOrBuilderpublic com.google.protobuf.ByteString getRuntimeBytes()
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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string runtime = 2;getRuntimeBytes in interface BuildConfigOrBuilderpublic String getEntryPoint()
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;getEntryPoint in interface BuildConfigOrBuilderpublic com.google.protobuf.ByteString getEntryPointBytes()
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;getEntryPointBytes in interface BuildConfigOrBuilderpublic boolean hasSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;hasSource in interface BuildConfigOrBuilderpublic Source getSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;getSource in interface BuildConfigOrBuilderpublic SourceOrBuilder getSourceOrBuilder()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;getSourceOrBuilder in interface BuildConfigOrBuilderpublic boolean hasSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasSourceProvenance in interface BuildConfigOrBuilderpublic SourceProvenance getSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceProvenance in interface BuildConfigOrBuilderpublic SourceProvenanceOrBuilder getSourceProvenanceOrBuilder()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceProvenanceOrBuilder in interface BuildConfigOrBuilderpublic String getWorkerPool()
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) = { ... }getWorkerPool in interface BuildConfigOrBuilderpublic com.google.protobuf.ByteString getWorkerPoolBytes()
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) = { ... }getWorkerPoolBytes in interface BuildConfigOrBuilderpublic int getEnvironmentVariablesCount()
BuildConfigOrBuilderUser-provided build-time environment variables for the function
map<string, string> environment_variables = 6;getEnvironmentVariablesCount in interface BuildConfigOrBuilderpublic boolean containsEnvironmentVariables(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;containsEnvironmentVariables in interface BuildConfigOrBuilder@Deprecated public Map<String,String> getEnvironmentVariables()
getEnvironmentVariablesMap() instead.getEnvironmentVariables in interface BuildConfigOrBuilderpublic Map<String,String> getEnvironmentVariablesMap()
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;getEnvironmentVariablesMap in interface BuildConfigOrBuilderpublic String getEnvironmentVariablesOrDefault(String key, String defaultValue)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;getEnvironmentVariablesOrDefault in interface BuildConfigOrBuilderpublic String getEnvironmentVariablesOrThrow(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;getEnvironmentVariablesOrThrow in interface BuildConfigOrBuilderpublic int getDockerRegistryValue()
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.v2.BuildConfig.DockerRegistry docker_registry = 10;getDockerRegistryValue in interface BuildConfigOrBuilderpublic BuildConfig.DockerRegistry getDockerRegistry()
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.v2.BuildConfig.DockerRegistry docker_registry = 10;getDockerRegistry in interface BuildConfigOrBuilderpublic String getDockerRepository()
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) = { ... }getDockerRepository in interface BuildConfigOrBuilderpublic com.google.protobuf.ByteString getDockerRepositoryBytes()
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) = { ... }getDockerRepositoryBytes in interface BuildConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static BuildConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BuildConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BuildConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BuildConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BuildConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BuildConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BuildConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static BuildConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BuildConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static BuildConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BuildConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static BuildConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic BuildConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static BuildConfig.Builder newBuilder()
public static BuildConfig.Builder newBuilder(BuildConfig prototype)
public BuildConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected BuildConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static BuildConfig getDefaultInstance()
public static com.google.protobuf.Parser<BuildConfig> parser()
public com.google.protobuf.Parser<BuildConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public BuildConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.