Interface TaskTemplateOrBuilder (0.31.0)

public interface TaskTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContainers(int index)

public abstract Container getContainers(int index)

Holds the single container that defines the unit of execution for this task.

repeated .google.cloud.run.v2.Container containers = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Container

getContainersCount()

public abstract int getContainersCount()

Holds the single container that defines the unit of execution for this task.

repeated .google.cloud.run.v2.Container containers = 1;

Returns
TypeDescription
int

getContainersList()

public abstract List<Container> getContainersList()

Holds the single container that defines the unit of execution for this task.

repeated .google.cloud.run.v2.Container containers = 1;

Returns
TypeDescription
List<Container>

getContainersOrBuilder(int index)

public abstract ContainerOrBuilder getContainersOrBuilder(int index)

Holds the single container that defines the unit of execution for this task.

repeated .google.cloud.run.v2.Container containers = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
ContainerOrBuilder

getContainersOrBuilderList()

public abstract List<? extends ContainerOrBuilder> getContainersOrBuilderList()

Holds the single container that defines the unit of execution for this task.

repeated .google.cloud.run.v2.Container containers = 1;

Returns
TypeDescription
List<? extends com.google.cloud.run.v2.ContainerOrBuilder>

getEncryptionKey()

public abstract String getEncryptionKey()

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

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

Returns
TypeDescription
String

The encryptionKey.

getEncryptionKeyBytes()

public abstract ByteString getEncryptionKeyBytes()

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

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

Returns
TypeDescription
ByteString

The bytes for encryptionKey.

getExecutionEnvironment()

public abstract ExecutionEnvironment getExecutionEnvironment()

The execution environment being used to host this Task.

.google.cloud.run.v2.ExecutionEnvironment execution_environment = 6;

Returns
TypeDescription
ExecutionEnvironment

The executionEnvironment.

getExecutionEnvironmentValue()

public abstract int getExecutionEnvironmentValue()

The execution environment being used to host this Task.

.google.cloud.run.v2.ExecutionEnvironment execution_environment = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for executionEnvironment.

getMaxRetries()

public abstract int getMaxRetries()

Number of retries allowed per Task, before marking this Task failed. Defaults to 3.

int32 max_retries = 3;

Returns
TypeDescription
int

The maxRetries.

getRetriesCase()

public abstract TaskTemplate.RetriesCase getRetriesCase()
Returns
TypeDescription
TaskTemplate.RetriesCase

getServiceAccount()

public abstract String getServiceAccount()

Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.

string service_account = 5;

Returns
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.

string service_account = 5;

Returns
TypeDescription
ByteString

The bytes for serviceAccount.

getTimeout()

public abstract Duration getTimeout()

Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.

.google.protobuf.Duration timeout = 4;

Returns
TypeDescription
Duration

The timeout.

getTimeoutOrBuilder()

public abstract DurationOrBuilder getTimeoutOrBuilder()

Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.

.google.protobuf.Duration timeout = 4;

Returns
TypeDescription
DurationOrBuilder

getVolumes(int index)

public abstract Volume getVolumes(int index)

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Volume

getVolumesCount()

public abstract int getVolumesCount()

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 2;

Returns
TypeDescription
int

getVolumesList()

public abstract List<Volume> getVolumesList()

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 2;

Returns
TypeDescription
List<Volume>

getVolumesOrBuilder(int index)

public abstract VolumeOrBuilder getVolumesOrBuilder(int index)

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
VolumeOrBuilder

getVolumesOrBuilderList()

public abstract List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

A list of Volumes to make available to containers.

repeated .google.cloud.run.v2.Volume volumes = 2;

Returns
TypeDescription
List<? extends com.google.cloud.run.v2.VolumeOrBuilder>

getVpcAccess()

public abstract VpcAccess getVpcAccess()

VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

.google.cloud.run.v2.VpcAccess vpc_access = 8;

Returns
TypeDescription
VpcAccess

The vpcAccess.

getVpcAccessOrBuilder()

public abstract VpcAccessOrBuilder getVpcAccessOrBuilder()

VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

.google.cloud.run.v2.VpcAccess vpc_access = 8;

Returns
TypeDescription
VpcAccessOrBuilder

hasMaxRetries()

public abstract boolean hasMaxRetries()

Number of retries allowed per Task, before marking this Task failed. Defaults to 3.

int32 max_retries = 3;

Returns
TypeDescription
boolean

Whether the maxRetries field is set.

hasTimeout()

public abstract boolean hasTimeout()

Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.

.google.protobuf.Duration timeout = 4;

Returns
TypeDescription
boolean

Whether the timeout field is set.

hasVpcAccess()

public abstract boolean hasVpcAccess()

VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

.google.cloud.run.v2.VpcAccess vpc_access = 8;

Returns
TypeDescription
boolean

Whether the vpcAccess field is set.