Class TaskTemplate (0.43.0) 

public final class TaskTemplate extends GeneratedMessageV3 implements TaskTemplateOrBuilder

TaskTemplate describes the data a task should have when created from a template.

Protobuf type google.cloud.run.v2.TaskTemplate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TaskTemplate

Static Fields

CONTAINERS_FIELD_NUMBER

public static final int CONTAINERS_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_KEY_FIELD_NUMBER

public static final int ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_ENVIRONMENT_FIELD_NUMBER

public static final int EXECUTION_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

MAX_RETRIES_FIELD_NUMBER

public static final int MAX_RETRIES_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

VOLUMES_FIELD_NUMBER

public static final int VOLUMES_FIELD_NUMBER
Field Value
Type Description
int

VPC_ACCESS_FIELD_NUMBER

public static final int VPC_ACCESS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TaskTemplate getDefaultInstance()
Returns
Type Description
TaskTemplate

getDescriptor()

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

newBuilder()

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

newBuilder(TaskTemplate prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getContainers(int index)

public 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
Name Description
index int
Returns
Type Description
Container

getContainersCount()

public int getContainersCount()

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

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

Returns
Type Description
int

getContainersList()

public 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
Type Description
List<Container>

getContainersOrBuilder(int index)

public 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
Name Description
index int
Returns
Type Description
ContainerOrBuilder

getContainersOrBuilderList()

public 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
Type Description
List<? extends com.google.cloud.run.v2.ContainerOrBuilder>

getDefaultInstanceForType()

public TaskTemplate getDefaultInstanceForType()
Returns
Type Description
TaskTemplate

getEncryptionKey()

public 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
Type Description
String

The encryptionKey.

getEncryptionKeyBytes()

public 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
Type Description
ByteString

The bytes for encryptionKey.

getExecutionEnvironment()

public ExecutionEnvironment getExecutionEnvironment()

The execution environment being used to host this Task.

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

Returns
Type Description
ExecutionEnvironment

The executionEnvironment.

getExecutionEnvironmentValue()

public int getExecutionEnvironmentValue()

The execution environment being used to host this Task.

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

Returns
Type Description
int

The enum numeric value on the wire for executionEnvironment.

getMaxRetries()

public int getMaxRetries()

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

int32 max_retries = 3;

Returns
Type Description
int

The maxRetries.

getParserForType()

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

getRetriesCase()

public TaskTemplate.RetriesCase getRetriesCase()
Returns
Type Description
TaskTemplate.RetriesCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public 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
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public 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
Type Description
ByteString

The bytes for serviceAccount.

getTimeout()

public 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
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

public 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
Type Description
DurationOrBuilder

getVolumes(int index)

public Volume getVolumes(int index)

A list of Volumes to make available to containers.

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

Parameter
Name Description
index int
Returns
Type Description
Volume

getVolumesCount()

public int getVolumesCount()

A list of Volumes to make available to containers.

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

Returns
Type Description
int

getVolumesList()

public List<Volume> getVolumesList()

A list of Volumes to make available to containers.

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

Returns
Type Description
List<Volume>

getVolumesOrBuilder(int index)

public VolumeOrBuilder getVolumesOrBuilder(int index)

A list of Volumes to make available to containers.

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

Parameter
Name Description
index int
Returns
Type Description
VolumeOrBuilder

getVolumesOrBuilderList()

public List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

A list of Volumes to make available to containers.

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

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

getVpcAccess()

public 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
Type Description
VpcAccess

The vpcAccess.

getVpcAccessOrBuilder()

public 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
Type Description
VpcAccessOrBuilder

hasMaxRetries()

public boolean hasMaxRetries()

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

int32 max_retries = 3;

Returns
Type Description
boolean

Whether the maxRetries field is set.

hasTimeout()

public 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
Type Description
boolean

Whether the timeout field is set.

hasVpcAccess()

public 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
Type Description
boolean

Whether the vpcAccess 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 TaskTemplate.Builder newBuilderForType()
Returns
Type Description
TaskTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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