Package com.google.cloud.run.v2

Interface JobOrBuilder

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

    • Method Detail

      • getName

        String getName()
         The fully qualified name of this Job.

 Format:
 projects/{project}/locations/{location}/jobs/{job}
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The fully qualified name of this Job.

 Format:
 projects/{project}/locations/{location}/jobs/{job}
        string name = 1;
        Returns:
        The bytes for name.

      • getUid

        String getUid()
         Output only. Server assigned unique identifier for the Execution. 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 Execution. 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()
         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.

 <p>Cloud Run API v2 does not support labels with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected. All system labels in v1 now have a
 corresponding field in v2 Job.
        map<string, string> labels = 4;

      • containsLabels

        boolean containsLabels​(String key)
         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.

 <p>Cloud Run API v2 does not support labels with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected. All system labels in v1 now have a
 corresponding field in v2 Job.
        map<string, string> labels = 4;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         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.

 <p>Cloud Run API v2 does not support labels with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected. All system labels in v1 now have a
 corresponding field in v2 Job.
        map<string, string> labels = 4;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         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.

 <p>Cloud Run API v2 does not support labels with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected. All system labels in v1 now have a
 corresponding field in v2 Job.
        map<string, string> labels = 4;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         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.

 <p>Cloud Run API v2 does not support labels with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected. All system labels in v1 now have a
 corresponding field in v2 Job.
        map<string, string> labels = 4;

      • getAnnotationsCount

        int getAnnotationsCount()
         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.

 <p>Cloud Run API v2 does not support annotations with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected on new resources. All system
 annotations in v1 now have a corresponding field in v2 Job.

 <p>This field follows Kubernetes annotations' namespacing, limits, and
 rules.
        map<string, string> annotations = 5;

      • containsAnnotations

        boolean containsAnnotations​(String key)
         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.

 <p>Cloud Run API v2 does not support annotations with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected on new resources. All system
 annotations in v1 now have a corresponding field in v2 Job.

 <p>This field follows Kubernetes annotations' namespacing, limits, and
 rules.
        map<string, string> annotations = 5;

      • getAnnotationsMap

        Map<String,​String> getAnnotationsMap()
         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.

 <p>Cloud Run API v2 does not support annotations with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected on new resources. All system
 annotations in v1 now have a corresponding field in v2 Job.

 <p>This field follows Kubernetes annotations' namespacing, limits, and
 rules.
        map<string, string> annotations = 5;

      • getAnnotationsOrDefault

        String getAnnotationsOrDefault​(String key,
                               String defaultValue)
         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.

 <p>Cloud Run API v2 does not support annotations with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected on new resources. All system
 annotations in v1 now have a corresponding field in v2 Job.

 <p>This field follows Kubernetes annotations' namespacing, limits, and
 rules.
        map<string, string> annotations = 5;

      • getAnnotationsOrThrow

        String getAnnotationsOrThrow​(String key)
         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.

 <p>Cloud Run API v2 does not support annotations with `run.googleapis.com`,
 `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
 namespaces, and they will be rejected on new resources. All system
 annotations in v1 now have a corresponding field in v2 Job.

 <p>This field follows Kubernetes annotations' namespacing, limits, and
 rules.
        map<string, string> annotations = 5;

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The creation time.
        .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. The creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The last-modified time.
        .google.protobuf.Timestamp update_time = 7 [(.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 = 7 [(.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 = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. The deletion time.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        com.google.protobuf.Timestamp getDeleteTime()
         Output only. The deletion time.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. The deletion time.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasExpireTime

        boolean hasExpireTime()
         Output only. For a deleted resource, the time after which it will be
 permamently deleted.
        .google.protobuf.Timestamp expire_time = 9 [(.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.
        .google.protobuf.Timestamp expire_time = 9 [(.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.
        .google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreator

        String getCreator()
         Output only. Email address of the authenticated creator.
        string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The creator.

      • getCreatorBytes

        com.google.protobuf.ByteString getCreatorBytes()
         Output only. Email address of the authenticated creator.
        string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for creator.

      • getLastModifier

        String getLastModifier()
         Output only. Email address of the last authenticated modifier.
        string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The lastModifier.

      • getLastModifierBytes

        com.google.protobuf.ByteString getLastModifierBytes()
         Output only. Email address of the last authenticated modifier.
        string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for lastModifier.

      • getClient

        String getClient()
         Arbitrary identifier for the API client.
        string client = 12;
        Returns:
        The client.

      • getClientBytes

        com.google.protobuf.ByteString getClientBytes()
         Arbitrary identifier for the API client.
        string client = 12;
        Returns:
        The bytes for client.

      • getClientVersion

        String getClientVersion()
         Arbitrary version identifier for the API client.
        string client_version = 13;
        Returns:
        The clientVersion.

      • getClientVersionBytes

        com.google.protobuf.ByteString getClientVersionBytes()
         Arbitrary version identifier for the API client.
        string client_version = 13;
        Returns:
        The bytes for clientVersion.

      • getLaunchStageValue

        int getLaunchStageValue()
         The launch stage as defined by [Google Cloud Platform
 Launch Stages](https://cloud.google.com/terms/launch-stages).
 Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA
 is assumed.
 Set the launch stage to a preview stage on input to allow use of preview
 features in that stage. On read (or output), describes whether the resource
 uses preview features.
 <p>
 For example, if ALPHA is provided as input, but only BETA and GA-level
 features are used, this field will be BETA on output.
        .google.api.LaunchStage launch_stage = 14;
        Returns:
        The enum numeric value on the wire for launchStage.

      • getLaunchStage

        com.google.api.LaunchStage getLaunchStage()
         The launch stage as defined by [Google Cloud Platform
 Launch Stages](https://cloud.google.com/terms/launch-stages).
 Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA
 is assumed.
 Set the launch stage to a preview stage on input to allow use of preview
 features in that stage. On read (or output), describes whether the resource
 uses preview features.
 <p>
 For example, if ALPHA is provided as input, but only BETA and GA-level
 features are used, this field will be BETA on output.
        .google.api.LaunchStage launch_stage = 14;
        Returns:
        The launchStage.

      • hasBinaryAuthorization

        boolean hasBinaryAuthorization()
         Settings for the Binary Authorization feature.
        .google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
        Returns:
        Whether the binaryAuthorization field is set.

      • getBinaryAuthorization

        BinaryAuthorization getBinaryAuthorization()
         Settings for the Binary Authorization feature.
        .google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
        Returns:
        The binaryAuthorization.

      • getBinaryAuthorizationOrBuilder

        BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()
         Settings for the Binary Authorization feature.
        .google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;

      • hasTemplate

        boolean hasTemplate()
         Required. The template used to create executions for this Job.
        .google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the template field is set.

      • getTemplate

        ExecutionTemplate getTemplate()
         Required. The template used to create executions for this Job.
        .google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The template.

      • getTemplateOrBuilder

        ExecutionTemplateOrBuilder getTemplateOrBuilder()
         Required. The template used to create executions for this Job.
        .google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];

      • getObservedGeneration

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

      • hasTerminalCondition

        boolean hasTerminalCondition()
         Output only. The Condition of this Job, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        .google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the terminalCondition field is set.

      • getTerminalCondition

        Condition getTerminalCondition()
         Output only. The Condition of this Job, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        .google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The terminalCondition.

      • getTerminalConditionOrBuilder

        ConditionOrBuilder getTerminalConditionOrBuilder()
         Output only. The Condition of this Job, containing its readiness status,
 and detailed error information in case it did not reach the desired state.
        .google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsList

        List<Condition> getConditionsList()
         Output only. The Conditions of all other associated sub-resources. They
 contain additional diagnostics information in case the Job does not reach
 its desired state. See comments in `reconciling` for additional information
 on reconciliation process in Cloud Run.
        repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditions

        Condition getConditions​(int index)
         Output only. The Conditions of all other associated sub-resources. They
 contain additional diagnostics information in case the Job does not reach
 its desired state. See comments in `reconciling` for additional information
 on reconciliation process in Cloud Run.
        repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsCount

        int getConditionsCount()
         Output only. The Conditions of all other associated sub-resources. They
 contain additional diagnostics information in case the Job does not reach
 its desired state. See comments in `reconciling` for additional information
 on reconciliation process in Cloud Run.
        repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsOrBuilderList

        List<? extends ConditionOrBuilder> getConditionsOrBuilderList()
         Output only. The Conditions of all other associated sub-resources. They
 contain additional diagnostics information in case the Job does not reach
 its desired state. See comments in `reconciling` for additional information
 on reconciliation process in Cloud Run.
        repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getConditionsOrBuilder

        ConditionOrBuilder getConditionsOrBuilder​(int index)
         Output only. The Conditions of all other associated sub-resources. They
 contain additional diagnostics information in case the Job does not reach
 its desired state. See comments in `reconciling` for additional information
 on reconciliation process in Cloud Run.
        repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getExecutionCount

        int getExecutionCount()
         Output only. Number of executions created for this job.
        int32 execution_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The executionCount.

      • hasLatestCreatedExecution

        boolean hasLatestCreatedExecution()
         Output only. Name of the last created execution.
        .google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the latestCreatedExecution field is set.

      • getLatestCreatedExecution

        ExecutionReference getLatestCreatedExecution()
         Output only. Name of the last created execution.
        .google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The latestCreatedExecution.

      • getLatestCreatedExecutionOrBuilder

        ExecutionReferenceOrBuilder getLatestCreatedExecutionOrBuilder()
         Output only. Name of the last created execution.
        .google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getReconciling

        boolean getReconciling()
         Output only. Returns true if the Job is currently being acted upon by the
 system to bring it into the desired state.

 When a new Job is created, or an existing one is updated, Cloud Run
 will asynchronously perform all necessary steps to bring the Job to the
 desired state. This process is called reconciliation.
 While reconciliation is in process, `observed_generation` and
 `latest_succeeded_execution`, will have transient values that might
 mismatch the intended state: Once reconciliation is over (and this field is
 false), there are two possible outcomes: reconciliation succeeded and the
 state matches the Job, or there was an error,  and reconciliation failed.
 This state can be found in `terminal_condition.state`.

 If reconciliation succeeded, the following fields will match:
 `observed_generation` and `generation`, `latest_succeeded_execution` and
 `latest_created_execution`.

 If reconciliation failed, `observed_generation` and
 `latest_succeeded_execution` will have the state of the last succeeded
 execution or empty for newly created Job. Additional information on the
 failure can be found in `terminal_condition` and `conditions`.
        bool reconciling = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The reconciling.

      • getSatisfiesPzs

        boolean getSatisfiesPzs()
         Output only. Reserved for future use.
        bool satisfies_pzs = 25 [(.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.