public final class BuildConfig extends 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
Static Fields
BUILD_FIELD_NUMBER
public static final int BUILD_FIELD_NUMBER
Field Value
DOCKER_REPOSITORY_FIELD_NUMBER
public static final int DOCKER_REPOSITORY_FIELD_NUMBER
Field Value
ENTRY_POINT_FIELD_NUMBER
public static final int ENTRY_POINT_FIELD_NUMBER
Field Value
ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int ENVIRONMENT_VARIABLES_FIELD_NUMBER
Field Value
RUNTIME_FIELD_NUMBER
public static final int RUNTIME_FIELD_NUMBER
Field Value
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER
Field Value
SOURCE_PROVENANCE_FIELD_NUMBER
public static final int SOURCE_PROVENANCE_FIELD_NUMBER
Field Value
WORKER_POOL_FIELD_NUMBER
public static final int WORKER_POOL_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BuildConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BuildConfig.Builder newBuilder()
Returns
newBuilder(BuildConfig prototype)
public static BuildConfig.Builder newBuilder(BuildConfig prototype)
Parameter
Returns
public static BuildConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BuildConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BuildConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BuildConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BuildConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BuildConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BuildConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BuildConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BuildConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BuildConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BuildConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BuildConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BuildConfig> parser()
Returns
Methods
containsEnvironmentVariables(String key)
public boolean containsEnvironmentVariables(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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) = { ... }
| Type | Description |
| String | The build.
|
getBuildBytes()
public 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) = { ... }
getDefaultInstanceForType()
public BuildConfig getDefaultInstanceForType()
Returns
getDockerRepository()
public String getDockerRepository()
Optional. 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The dockerRepository.
|
getDockerRepositoryBytes()
public ByteString getDockerRepositoryBytes()
Optional. 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for dockerRepository.
|
getEntryPoint()
public 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;
| Type | Description |
| String | The entryPoint.
|
getEntryPointBytes()
public 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;
| Type | Description |
| ByteString | The bytes for entryPoint.
|
getEnvironmentVariables()
public Map<String,String> getEnvironmentVariables()
Returns
getEnvironmentVariablesCount()
public int getEnvironmentVariablesCount()
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getEnvironmentVariablesMap()
public Map<String,String> getEnvironmentVariablesMap()
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getEnvironmentVariablesOrDefault(String key, String defaultValue)
public String getEnvironmentVariablesOrDefault(String key, String defaultValue)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getEnvironmentVariablesOrThrow(String key)
public String getEnvironmentVariablesOrThrow(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getParserForType()
public Parser<BuildConfig> getParserForType()
Returns
Overrides
getRuntime()
public 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.
string runtime = 2;
| Type | Description |
| String | The runtime.
|
getRuntimeBytes()
public 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.
string runtime = 2;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSource()
public Source getSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
| Type | Description |
| Source | The source.
|
getSourceOrBuilder()
public SourceOrBuilder getSourceOrBuilder()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
getSourceProvenance()
public SourceProvenance getSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceProvenanceOrBuilder()
public SourceProvenanceOrBuilder getSourceProvenanceOrBuilder()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWorkerPool()
public 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) = { ... }
| Type | Description |
| String | The workerPool.
|
getWorkerPoolBytes()
public 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) = { ... }
| Type | Description |
| ByteString | The bytes for workerPool.
|
hasSource()
public boolean hasSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
| Type | Description |
| boolean | Whether the source field is set.
|
hasSourceProvenance()
public boolean hasSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the sourceProvenance field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BuildConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BuildConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BuildConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
