Package com.google.cloud.run.v2

Interface TaskOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Task, Task.Builder
    public interface TaskOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The unique name of this Task.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The unique name of this Task.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getUid

        String getUid()
         Output only. Server assigned unique identifier for the Task. The value is a
 UUID4 string and guaranteed to remain unchanged until the resource is
 deleted.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The uid.

      • getUidBytes

        com.google.protobuf.ByteString getUidBytes()
         Output only. Server assigned unique identifier for the Task. The value is a
 UUID4 string and guaranteed to remain unchanged until the resource is
 deleted.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for uid.

      • getGeneration

        long getGeneration()
         Output only. A number that monotonically increases every time the user
 modifies the desired state.
        int64 generation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The generation.

      • getLabelsCount

        int getLabelsCount()
         Output only. Unstructured key value map that can be used to organize and
 categorize objects. User-provided labels are shared with Google's billing
 system, so they can be used to filter, or break down billing charges by
 team, component, environment, state, etc. For more information, visit
 https://cloud.google.com/resource-manager/docs/creating-managing-labels or
 https://cloud.google.com/run/docs/configuring/labels
        map<string, string> labels = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • containsLabels

        boolean containsLabels​(String key)
         Output only. Unstructured key value map that can be used to organize and
 categorize objects. User-provided labels are shared with Google's billing
 system, so they can be used to filter, or break down billing charges by
 team, component, environment, state, etc. For more information, visit
 https://cloud.google.com/resource-manager/docs/creating-managing-labels or
 https://cloud.google.com/run/docs/configuring/labels
        map<string, string> labels = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Output only. Unstructured key value map that can be used to organize and
 categorize objects. User-provided labels are shared with Google's billing
 system, so they can be used to filter, or break down billing charges by
 team, component, environment, state, etc. For more information, visit
 https://cloud.google.com/resource-manager/docs/creating-managing-labels or
 https://cloud.google.com/run/docs/configuring/labels
        map<string, string> labels = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Output only. Unstructured key value map that can be used to organize and
 categorize objects. User-provided labels are shared with Google's billing
 system, so they can be used to filter, or break down billing charges by
 team, component, environment, state, etc. For more information, visit
 https://cloud.google.com/resource-manager/docs/creating-managing-labels or
 https://cloud.google.com/run/docs/configuring/labels
        map<string, string> labels = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Output only. Unstructured key value map that can be used to organize and
 categorize objects. User-provided labels are shared with Google's billing
 system, so they can be used to filter, or break down billing charges by
 team, component, environment, state, etc. For more information, visit
 https://cloud.google.com/resource-manager/docs/creating-managing-labels or
 https://cloud.google.com/run/docs/configuring/labels
        map<string, string> labels = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getAnnotationsCount

        int getAnnotationsCount()
         Output only. Unstructured key value map that may
 be set by external tools to store and arbitrary metadata.
 They are not queryable and should be preserved
 when modifying objects.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • containsAnnotations

        boolean containsAnnotations​(String key)
         Output only. Unstructured key value map that may
 be set by external tools to store and arbitrary metadata.
 They are not queryable and should be preserved
 when modifying objects.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getAnnotationsMap

        Map<String,​String> getAnnotationsMap()
         Output only. Unstructured key value map that may
 be set by external tools to store and arbitrary metadata.
 They are not queryable and should be preserved
 when modifying objects.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getAnnotationsOrDefault

        String getAnnotationsOrDefault​(String key,
                               String defaultValue)
         Output only. Unstructured key value map that may
 be set by external tools to store and arbitrary metadata.
 They are not queryable and should be preserved
 when modifying objects.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getAnnotationsOrThrow

        String getAnnotationsOrThrow​(String key)
         Output only. Unstructured key value map that may
 be set by external tools to store and arbitrary metadata.
 They are not queryable and should be preserved
 when modifying objects.
        map<string, string> annotations = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Represents time when the task was created by the job
 controller. It is not guaranteed to be set in happens-before order across
 separate operations.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Represents time when the task was created by the job
 controller. It is not guaranteed to be set in happens-before order across
 separate operations.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Represents time when the task was created by the job
 controller. It is not guaranteed to be set in happens-before order across
 separate operations.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasStartTime

        boolean hasStartTime()
         Output only. Represents time when the task started to run.
 It is not guaranteed to be set in happens-before order across separate
 operations.
        .google.protobuf.Timestamp start_time = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the startTime field is set.

      • getStartTime

        com.google.protobuf.Timestamp getStartTime()
         Output only. Represents time when the task started to run.
 It is not guaranteed to be set in happens-before order across separate
 operations.
        .google.protobuf.Timestamp start_time = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Represents time when the task started to run.
 It is not guaranteed to be set in happens-before order across separate
 operations.
        .google.protobuf.Timestamp start_time = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasCompletionTime

        boolean hasCompletionTime()
         Output only. Represents time when the Task was completed. It is not
 guaranteed to be set in happens-before order across separate operations.
        .google.protobuf.Timestamp completion_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the completionTime field is set.

      • getCompletionTime

        com.google.protobuf.Timestamp getCompletionTime()
         Output only. Represents time when the Task was completed. It is not
 guaranteed to be set in happens-before order across separate operations.
        .google.protobuf.Timestamp completion_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The completionTime.

      • getCompletionTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCompletionTimeOrBuilder()
         Output only. Represents time when the Task was completed. It is not
 guaranteed to be set in happens-before order across separate operations.
        .google.protobuf.Timestamp completion_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The last-modified time.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. The last-modified time.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The last-modified time.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. For a deleted resource, the deletion time. It is only
 populated as a response to a Delete request.
        .google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        com.google.protobuf.Timestamp getDeleteTime()
         Output only. For a deleted resource, the deletion time. It is only
 populated as a response to a Delete request.
        .google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. For a deleted resource, the deletion time. It is only
 populated as a response to a Delete request.
        .google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasExpireTime

        boolean hasExpireTime()
         Output only. For a deleted resource, the time after which it will be
 permamently deleted. It is only populated as a response to a Delete
 request.
        .google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        com.google.protobuf.Timestamp getExpireTime()
         Output only. For a deleted resource, the time after which it will be
 permamently deleted. It is only populated as a response to a Delete
 request.
        .google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
         Output only. For a deleted resource, the time after which it will be
 permamently deleted. It is only populated as a response to a Delete
 request.
        .google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getJob

        String getJob()
         Output only. The name of the parent Job.
        string job = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The job.

      • getJobBytes

        com.google.protobuf.ByteString getJobBytes()
         Output only. The name of the parent Job.
        string job = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for job.

      • getExecution

        String getExecution()
         Output only. The name of the parent Execution.
        string execution = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The execution.

      • getExecutionBytes

        com.google.protobuf.ByteString getExecutionBytes()
         Output only. The name of the parent Execution.
        string execution = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for execution.

      • getContainersList

        List<Container> getContainersList()
         Holds the single container that defines the unit of execution for this
 task.
        repeated .google.cloud.run.v2.Container containers = 14;

      • getContainers

        Container getContainers​(int index)
         Holds the single container that defines the unit of execution for this
 task.
        repeated .google.cloud.run.v2.Container containers = 14;

      • getContainersCount

        int getContainersCount()
         Holds the single container that defines the unit of execution for this
 task.
        repeated .google.cloud.run.v2.Container containers = 14;

      • getContainersOrBuilderList

        List<? extends ContainerOrBuilder> getContainersOrBuilderList()
         Holds the single container that defines the unit of execution for this
 task.
        repeated .google.cloud.run.v2.Container containers = 14;

      • getContainersOrBuilder

        ContainerOrBuilder getContainersOrBuilder​(int index)
         Holds the single container that defines the unit of execution for this
 task.
        repeated .google.cloud.run.v2.Container containers = 14;

      • getVolumesList

        List<Volume> getVolumesList()
         A list of Volumes to make available to containers.
        repeated .google.cloud.run.v2.Volume volumes = 15;

      • getVolumes

        Volume getVolumes​(int index)
         A list of Volumes to make available to containers.
        repeated .google.cloud.run.v2.Volume volumes = 15;

      • getVolumesCount

        int getVolumesCount()
         A list of Volumes to make available to containers.
        repeated .google.cloud.run.v2.Volume volumes = 15;

      • getVolumesOrBuilderList

        List<? extends VolumeOrBuilder> getVolumesOrBuilderList()
         A list of Volumes to make available to containers.
        repeated .google.cloud.run.v2.Volume volumes = 15;

      • getVolumesOrBuilder

        VolumeOrBuilder getVolumesOrBuilder​(int index)
         A list of Volumes to make available to containers.
        repeated .google.cloud.run.v2.Volume volumes = 15;

      • getMaxRetries

        int getMaxRetries()
         Number of retries allowed per Task, before marking this Task failed.
        int32 max_retries = 16;
        Returns:
        The maxRetries.

      • hasTimeout

        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.
        .google.protobuf.Duration timeout = 17;
        Returns:
        Whether the timeout field is set.

      • getTimeout

        com.google.protobuf.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.
        .google.protobuf.Duration timeout = 17;
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        com.google.protobuf.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.
        .google.protobuf.Duration timeout = 17;

      • getServiceAccount

        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 = 18;
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        com.google.protobuf.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 = 18;
        Returns:
        The bytes for serviceAccount.

      • getExecutionEnvironmentValue

        int getExecutionEnvironmentValue()
         The execution environment being used to host this Task.
        .google.cloud.run.v2.ExecutionEnvironment execution_environment = 20;
        Returns:
        The enum numeric value on the wire for executionEnvironment.

      • getExecutionEnvironment

        ExecutionEnvironment getExecutionEnvironment()
         The execution environment being used to host this Task.
        .google.cloud.run.v2.ExecutionEnvironment execution_environment = 20;
        Returns:
        The executionEnvironment.

      • getReconciling

        boolean getReconciling()
         Output only. Indicates whether the resource's reconciliation is still in
 progress. See comments in `Job.reconciling` for additional information on
 reconciliation process in Cloud Run.
        bool reconciling = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The reconciling.

      • getConditionsList

        List<Condition> getConditionsList()
         Output only. The Condition of this Task, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        repeated .google.cloud.run.v2.Condition conditions = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditions

        Condition getConditions​(int index)
         Output only. The Condition of this Task, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        repeated .google.cloud.run.v2.Condition conditions = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsCount

        int getConditionsCount()
         Output only. The Condition of this Task, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        repeated .google.cloud.run.v2.Condition conditions = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsOrBuilderList

        List<? extends ConditionOrBuilder> getConditionsOrBuilderList()
         Output only. The Condition of this Task, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        repeated .google.cloud.run.v2.Condition conditions = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsOrBuilder

        ConditionOrBuilder getConditionsOrBuilder​(int index)
         Output only. The Condition of this Task, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        repeated .google.cloud.run.v2.Condition conditions = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getObservedGeneration

        long getObservedGeneration()
         Output only. The generation of this Task. See comments in `Job.reconciling`
 for additional information on reconciliation process in Cloud Run.
        int64 observed_generation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The observedGeneration.

      • getIndex

        int getIndex()
         Output only. Index of the Task, unique per execution, and beginning at 0.
        int32 index = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The index.

      • getRetried

        int getRetried()
         Output only. The number of times this Task was retried.
 Tasks are retried when they fail up to the maxRetries limit.
        int32 retried = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The retried.

      • hasLastAttemptResult

        boolean hasLastAttemptResult()
         Output only. Result of the last attempt of this Task.
        .google.cloud.run.v2.TaskAttemptResult last_attempt_result = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the lastAttemptResult field is set.

      • getLastAttemptResult

        TaskAttemptResult getLastAttemptResult()
         Output only. Result of the last attempt of this Task.
        .google.cloud.run.v2.TaskAttemptResult last_attempt_result = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The lastAttemptResult.

      • getLastAttemptResultOrBuilder

        TaskAttemptResultOrBuilder getLastAttemptResultOrBuilder()
         Output only. Result of the last attempt of this Task.
        .google.cloud.run.v2.TaskAttemptResult last_attempt_result = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getEncryptionKey

        String getEncryptionKey()
         Output only. 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 = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The encryptionKey.

      • getEncryptionKeyBytes

        com.google.protobuf.ByteString getEncryptionKeyBytes()
         Output only. 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 = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for encryptionKey.

      • hasVpcAccess

        boolean hasVpcAccess()
         Output only. 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 = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the vpcAccess field is set.

      • getVpcAccess

        VpcAccess getVpcAccess()
         Output only. 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 = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The vpcAccess.

      • getVpcAccessOrBuilder

        VpcAccessOrBuilder getVpcAccessOrBuilder()
         Output only. 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 = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLogUri

        String getLogUri()
         Output only. URI where logs for this execution can be found in Cloud
 Console.
        string log_uri = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The logUri.

      • getLogUriBytes

        com.google.protobuf.ByteString getLogUriBytes()
         Output only. URI where logs for this execution can be found in Cloud
 Console.
        string log_uri = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for logUri.

      • getSatisfiesPzs

        boolean getSatisfiesPzs()
         Output only. Reserved for future use.
        bool satisfies_pzs = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The satisfiesPzs.

      • getEtag

        String getEtag()
         Output only. A system-generated fingerprint for this version of the
 resource. May be used to detect modification conflict during updates.
        string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         Output only. A system-generated fingerprint for this version of the
 resource. May be used to detect modification conflict during updates.
        string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for etag.