Class ExecutionConfig (1.43.0)

public final class ExecutionConfig extends GeneratedMessageV3 implements ExecutionConfigOrBuilder

Configuration of the environment to use when calling Skaffold.

Protobuf type google.cloud.deploy.v1.ExecutionConfig

Static Fields

ARTIFACT_STORAGE_FIELD_NUMBER

public static final int ARTIFACT_STORAGE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_POOL_FIELD_NUMBER

public static final int DEFAULT_POOL_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_TIMEOUT_FIELD_NUMBER

public static final int EXECUTION_TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_POOL_FIELD_NUMBER

public static final int PRIVATE_POOL_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

USAGES_FIELD_NUMBER

public static final int USAGES_FIELD_NUMBER
Field Value
Type Description
int

VERBOSE_FIELD_NUMBER

public static final int VERBOSE_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 ExecutionConfig getDefaultInstance()
Returns
Type Description
ExecutionConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ExecutionConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getArtifactStorage()

public String getArtifactStorage()

Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.

string artifact_storage = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The artifactStorage.

getArtifactStorageBytes()

public ByteString getArtifactStorageBytes()

Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.

string artifact_storage = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for artifactStorage.

getDefaultInstanceForType()

public ExecutionConfig getDefaultInstanceForType()
Returns
Type Description
ExecutionConfig

getDefaultPool()

public DefaultPool getDefaultPool()

Optional. Use default Cloud Build pool.

.google.cloud.deploy.v1.DefaultPool default_pool = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DefaultPool

The defaultPool.

getDefaultPoolOrBuilder()

public DefaultPoolOrBuilder getDefaultPoolOrBuilder()

Optional. Use default Cloud Build pool.

.google.cloud.deploy.v1.DefaultPool default_pool = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DefaultPoolOrBuilder

getExecutionEnvironmentCase()

public ExecutionConfig.ExecutionEnvironmentCase getExecutionEnvironmentCase()
Returns
Type Description
ExecutionConfig.ExecutionEnvironmentCase

getExecutionTimeout()

public Duration getExecutionTimeout()

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The executionTimeout.

getExecutionTimeoutOrBuilder()

public DurationOrBuilder getExecutionTimeoutOrBuilder()

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getParserForType()

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

getPrivatePool()

public PrivatePool getPrivatePool()

Optional. Use private Cloud Build pool.

.google.cloud.deploy.v1.PrivatePool private_pool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivatePool

The privatePool.

getPrivatePoolOrBuilder()

public PrivatePoolOrBuilder getPrivatePoolOrBuilder()

Optional. Use private Cloud Build pool.

.google.cloud.deploy.v1.PrivatePool private_pool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PrivatePoolOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

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

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

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

Returns
Type Description
ByteString

The bytes for serviceAccount.

getUsages(int index)

public ExecutionConfig.ExecutionEnvironmentUsage getUsages(int index)

Required. Usages when this configuration should be applied.

repeated .google.cloud.deploy.v1.ExecutionConfig.ExecutionEnvironmentUsage usages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
ExecutionConfig.ExecutionEnvironmentUsage

The usages at the given index.

getUsagesCount()

public int getUsagesCount()

Required. Usages when this configuration should be applied.

repeated .google.cloud.deploy.v1.ExecutionConfig.ExecutionEnvironmentUsage usages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of usages.

getUsagesList()

public List<ExecutionConfig.ExecutionEnvironmentUsage> getUsagesList()

Required. Usages when this configuration should be applied.

repeated .google.cloud.deploy.v1.ExecutionConfig.ExecutionEnvironmentUsage usages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ExecutionEnvironmentUsage>

A list containing the usages.

getUsagesValue(int index)

public int getUsagesValue(int index)

Required. Usages when this configuration should be applied.

repeated .google.cloud.deploy.v1.ExecutionConfig.ExecutionEnvironmentUsage usages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of usages at the given index.

getUsagesValueList()

public List<Integer> getUsagesValueList()

Required. Usages when this configuration should be applied.

repeated .google.cloud.deploy.v1.ExecutionConfig.ExecutionEnvironmentUsage usages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for usages.

getVerbose()

public boolean getVerbose()

Optional. If true, additional logging will be enabled when running builds in this execution environment.

bool verbose = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The verbose.

getWorkerPool()

public String getWorkerPool()

Optional. The resource name of the WorkerPool, with the format projects/{project}/locations/{location}/workerPools/{worker_pool}. If this optional field is unspecified, the default Cloud Build pool will be used.

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

Returns
Type Description
String

The workerPool.

getWorkerPoolBytes()

public ByteString getWorkerPoolBytes()

Optional. The resource name of the WorkerPool, with the format projects/{project}/locations/{location}/workerPools/{worker_pool}. If this optional field is unspecified, the default Cloud Build pool will be used.

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

Returns
Type Description
ByteString

The bytes for workerPool.

hasDefaultPool()

public boolean hasDefaultPool()

Optional. Use default Cloud Build pool.

.google.cloud.deploy.v1.DefaultPool default_pool = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultPool field is set.

hasExecutionTimeout()

public boolean hasExecutionTimeout()

Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the executionTimeout field is set.

hasPrivatePool()

public boolean hasPrivatePool()

Optional. Use private Cloud Build pool.

.google.cloud.deploy.v1.PrivatePool private_pool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the privatePool field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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