Class BuildConfig (0.58.0)

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.run.v2.BuildConfig

Static Fields

BASE_IMAGE_FIELD_NUMBER

public static final int BASE_IMAGE_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_AUTOMATIC_UPDATES_FIELD_NUMBER

public static final int ENABLE_AUTOMATIC_UPDATES_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_VARIABLES_FIELD_NUMBER

public static final int ENVIRONMENT_VARIABLES_FIELD_NUMBER
Field Value
Type Description
int

FUNCTION_TARGET_FIELD_NUMBER

public static final int FUNCTION_TARGET_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_LOCATION_FIELD_NUMBER

public static final int SOURCE_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

WORKER_POOL_FIELD_NUMBER

public static final int WORKER_POOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BuildConfig getDefaultInstance()
Returns
Type Description
BuildConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BuildConfig.Builder newBuilder()
Returns
Type Description
BuildConfig.Builder

newBuilder(BuildConfig prototype)

public static BuildConfig.Builder newBuilder(BuildConfig prototype)
Parameter
Name Description
prototype BuildConfig
Returns
Type Description
BuildConfig.Builder

parseDelimitedFrom(InputStream input)

public static BuildConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BuildConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BuildConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuildConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BuildConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BuildConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BuildConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuildConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BuildConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BuildConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BuildConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuildConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BuildConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BuildConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BuildConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuildConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BuildConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BuildConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BuildConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuildConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BuildConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BuildConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BuildConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BuildConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BuildConfig> parser()
Returns
Type Description
Parser<BuildConfig>

Methods

containsEnvironmentVariables(String key)

public boolean containsEnvironmentVariables(String key)

Optional. User-provided build-time environment variables for the function

map<string, string> environment_variables = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBaseImage()

public String getBaseImage()

Optional. The base image used to build the function.

string base_image = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The baseImage.

getBaseImageBytes()

public ByteString getBaseImageBytes()

Optional. The base image used to build the function.

string base_image = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for baseImage.

getDefaultInstanceForType()

public BuildConfig getDefaultInstanceForType()
Returns
Type Description
BuildConfig

getEnableAutomaticUpdates()

public boolean getEnableAutomaticUpdates()

Optional. Sets whether the function will receive automatic base image updates.

bool enable_automatic_updates = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableAutomaticUpdates.

getEnvironmentVariables() (deprecated)

public Map<String,String> getEnvironmentVariables()
Returns
Type Description
Map<String,String>

getEnvironmentVariablesCount()

public int getEnvironmentVariablesCount()

Optional. User-provided build-time environment variables for the function

map<string, string> environment_variables = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEnvironmentVariablesMap()

public Map<String,String> getEnvironmentVariablesMap()

Optional. User-provided build-time environment variables for the function

map<string, string> environment_variables = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getEnvironmentVariablesOrDefault(String key, String defaultValue)

public String getEnvironmentVariablesOrDefault(String key, String defaultValue)

Optional. User-provided build-time environment variables for the function

map<string, string> environment_variables = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvironmentVariablesOrThrow(String key)

public String getEnvironmentVariablesOrThrow(String key)

Optional. User-provided build-time environment variables for the function

map<string, string> environment_variables = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getFunctionTarget()

public String getFunctionTarget()

Optional. 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".

string function_target = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The functionTarget.

getFunctionTargetBytes()

public ByteString getFunctionTargetBytes()

Optional. 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".

string function_target = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for functionTarget.

getImageUri()

public String getImageUri()

Optional. Artifact Registry URI to store the built image.

string image_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

Optional. Artifact Registry URI to store the built image.

string image_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for imageUri.

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<BuildConfig> getParserForType()
Returns
Type Description
Parser<BuildConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Optional. Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

string service_account = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Optional. Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

string service_account = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccount.

getSourceLocation()

public String getSourceLocation()

The Cloud Storage bucket URI where the function source code is located.

string source_location = 2;

Returns
Type Description
String

The sourceLocation.

getSourceLocationBytes()

public ByteString getSourceLocationBytes()

The Cloud Storage bucket URI where the function source code is located.

string source_location = 2;

Returns
Type Description
ByteString

The bytes for sourceLocation.

getWorkerPool()

public String getWorkerPool()

Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run 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.

string worker_pool = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The workerPool.

getWorkerPoolBytes()

public ByteString getWorkerPoolBytes()

Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run 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.

string worker_pool = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for workerPool.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BuildConfig.Builder newBuilderForType()
Returns
Type Description
BuildConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BuildConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BuildConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BuildConfig.Builder toBuilder()
Returns
Type Description
BuildConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException