Package com.google.cloud.deploy.v1

Interface RolloutOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Rollout, Rollout.Builder
@Generated public interface RolloutOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. Name of the `Rollout`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
 The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the `Rollout`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
 The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getUid

      String getUid()
       Output only. Unique identifier of the `Rollout`.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The uid.

    • getUidBytes

      com.google.protobuf.ByteString getUidBytes()
       Output only. Unique identifier of the `Rollout`.
      string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for uid.

    • getDescription

      String getDescription()
       Optional. Description of the `Rollout` for user purposes. Max length is 255
 characters.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the `Rollout` for user purposes. Max length is 255
 characters.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getAnnotationsCount

      int getAnnotationsCount()
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. See
 https://google.aip.dev/128#annotations for more details such as format and
 size limitations.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • containsAnnotations

      boolean containsAnnotations(String key)
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. See
 https://google.aip.dev/128#annotations for more details such as format and
 size limitations.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.

    • getAnnotationsMap

      Map<String,String> getAnnotationsMap()
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. See
 https://google.aip.dev/128#annotations for more details such as format and
 size limitations.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrDefault

      String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. See
 https://google.aip.dev/128#annotations for more details such as format and
 size limitations.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrThrow

      String getAnnotationsOrThrow(String key)
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. See
 https://google.aip.dev/128#annotations for more details such as format and
 size limitations.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsCount

      int getLabelsCount()
       Labels are attributes that can be set and used by both the
 user and by Cloud Deploy. Labels must meet the following constraints:

 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 * All characters must use UTF-8 encoding, and international characters are
 allowed.
 * Keys must start with a lowercase letter or international character.
 * Each resource is limited to a maximum of 64 labels.

 Both keys and values are additionally constrained to be <= 128 bytes.
      map<string, string> labels = 5;

    • containsLabels

      boolean containsLabels(String key)
       Labels are attributes that can be set and used by both the
 user and by Cloud Deploy. Labels must meet the following constraints:

 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 * All characters must use UTF-8 encoding, and international characters are
 allowed.
 * Keys must start with a lowercase letter or international character.
 * Each resource is limited to a maximum of 64 labels.

 Both keys and values are additionally constrained to be <= 128 bytes.
      map<string, string> labels = 5;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Labels are attributes that can be set and used by both the
 user and by Cloud Deploy. Labels must meet the following constraints:

 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 * All characters must use UTF-8 encoding, and international characters are
 allowed.
 * Keys must start with a lowercase letter or international character.
 * Each resource is limited to a maximum of 64 labels.

 Both keys and values are additionally constrained to be <= 128 bytes.
      map<string, string> labels = 5;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Labels are attributes that can be set and used by both the
 user and by Cloud Deploy. Labels must meet the following constraints:

 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 * All characters must use UTF-8 encoding, and international characters are
 allowed.
 * Keys must start with a lowercase letter or international character.
 * Each resource is limited to a maximum of 64 labels.

 Both keys and values are additionally constrained to be <= 128 bytes.
      map<string, string> labels = 5;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Labels are attributes that can be set and used by both the
 user and by Cloud Deploy. Labels must meet the following constraints:

 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes.
 * All characters must use UTF-8 encoding, and international characters are
 allowed.
 * Keys must start with a lowercase letter or international character.
 * Each resource is limited to a maximum of 64 labels.

 Both keys and values are additionally constrained to be <= 128 bytes.
      map<string, string> labels = 5;

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time at which the `Rollout` was created.
      .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. Time at which the `Rollout` was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time at which the `Rollout` was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasApproveTime

      boolean hasApproveTime()
       Output only. Time at which the `Rollout` was approved.
      .google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the approveTime field is set.

    • getApproveTime

      com.google.protobuf.Timestamp getApproveTime()
       Output only. Time at which the `Rollout` was approved.
      .google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approveTime.

    • getApproveTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getApproveTimeOrBuilder()
       Output only. Time at which the `Rollout` was approved.
      .google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasEnqueueTime

      boolean hasEnqueueTime()
       Output only. Time at which the `Rollout` was enqueued.
      .google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the enqueueTime field is set.

    • getEnqueueTime

      com.google.protobuf.Timestamp getEnqueueTime()
       Output only. Time at which the `Rollout` was enqueued.
      .google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enqueueTime.

    • getEnqueueTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEnqueueTimeOrBuilder()
       Output only. Time at which the `Rollout` was enqueued.
      .google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDeployStartTime

      boolean hasDeployStartTime()
       Output only. Time at which the `Rollout` started deploying.
      .google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the deployStartTime field is set.

    • getDeployStartTime

      com.google.protobuf.Timestamp getDeployStartTime()
       Output only. Time at which the `Rollout` started deploying.
      .google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deployStartTime.

    • getDeployStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getDeployStartTimeOrBuilder()
       Output only. Time at which the `Rollout` started deploying.
      .google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDeployEndTime

      boolean hasDeployEndTime()
       Output only. Time at which the `Rollout` finished deploying.
      .google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the deployEndTime field is set.

    • getDeployEndTime

      com.google.protobuf.Timestamp getDeployEndTime()
       Output only. Time at which the `Rollout` finished deploying.
      .google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deployEndTime.

    • getDeployEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getDeployEndTimeOrBuilder()
       Output only. Time at which the `Rollout` finished deploying.
      .google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTargetId

      String getTargetId()
       Required. The ID of Target to which this `Rollout` is deploying.
      string target_id = 18 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The targetId.

    • getTargetIdBytes

      com.google.protobuf.ByteString getTargetIdBytes()
       Required. The ID of Target to which this `Rollout` is deploying.
      string target_id = 18 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for targetId.

    • getApprovalStateValue

      int getApprovalStateValue()
       Output only. Approval state of the `Rollout`.
      .google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for approvalState.

    • getApprovalState

      Rollout.ApprovalState getApprovalState()
       Output only. Approval state of the `Rollout`.
      .google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approvalState.

    • getStateValue

      int getStateValue()
       Output only. Current state of the `Rollout`.
      .google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Rollout.State getState()
       Output only. Current state of the `Rollout`.
      .google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getFailureReason

      String getFailureReason()
       Output only. Additional information about the rollout failure, if
 available.
      string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The failureReason.

    • getFailureReasonBytes

      com.google.protobuf.ByteString getFailureReasonBytes()
       Output only. Additional information about the rollout failure, if
 available.
      string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for failureReason.

    • getDeployingBuild

      String getDeployingBuild()
       Output only. The resource name of the Cloud Build `Build` object that is
 used to deploy the Rollout. Format is
 `projects/{project}/locations/{location}/builds/{build}`.
      string deploying_build = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The deployingBuild.

    • getDeployingBuildBytes

      com.google.protobuf.ByteString getDeployingBuildBytes()
       Output only. The resource name of the Cloud Build `Build` object that is
 used to deploy the Rollout. Format is
 `projects/{project}/locations/{location}/builds/{build}`.
      string deploying_build = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for deployingBuild.

    • getEtag

      String getEtag()
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 16;
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
      string etag = 16;
      Returns:
      The bytes for etag.

    • getDeployFailureCauseValue

      int getDeployFailureCauseValue()
       Output only. The reason this rollout failed. This will always be
 unspecified while the rollout is in progress.
      .google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for deployFailureCause.

    • getDeployFailureCause

      Rollout.FailureCause getDeployFailureCause()
       Output only. The reason this rollout failed. This will always be
 unspecified while the rollout is in progress.
      .google.cloud.deploy.v1.Rollout.FailureCause deploy_failure_cause = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deployFailureCause.

    • getPhasesList

      List<Phase> getPhasesList()
       Output only. The phases that represent the workflows of this `Rollout`.
      repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPhases

      Phase getPhases(int index)
       Output only. The phases that represent the workflows of this `Rollout`.
      repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPhasesCount

      int getPhasesCount()
       Output only. The phases that represent the workflows of this `Rollout`.
      repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPhasesOrBuilderList

      List<? extends PhaseOrBuilder> getPhasesOrBuilderList()
       Output only. The phases that represent the workflows of this `Rollout`.
      repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPhasesOrBuilder

      PhaseOrBuilder getPhasesOrBuilder(int index)
       Output only. The phases that represent the workflows of this `Rollout`.
      repeated .google.cloud.deploy.v1.Phase phases = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasMetadata

      boolean hasMetadata()
       Output only. Metadata contains information about the rollout.
      .google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the metadata field is set.

    • getMetadata

      Metadata getMetadata()
       Output only. Metadata contains information about the rollout.
      .google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The metadata.

    • getMetadataOrBuilder

      MetadataOrBuilder getMetadataOrBuilder()
       Output only. Metadata contains information about the rollout.
      .google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getControllerRollout

      String getControllerRollout()
       Output only. Name of the `ControllerRollout`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
      string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The controllerRollout.

    • getControllerRolloutBytes

      com.google.protobuf.ByteString getControllerRolloutBytes()
       Output only. Name of the `ControllerRollout`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
      string controller_rollout = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for controllerRollout.

    • getRollbackOfRollout

      String getRollbackOfRollout()
       Output only. Name of the `Rollout` that is rolled back by this `Rollout`.
 Empty if this `Rollout` wasn't created as a rollback.
      string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The rollbackOfRollout.

    • getRollbackOfRolloutBytes

      com.google.protobuf.ByteString getRollbackOfRolloutBytes()
       Output only. Name of the `Rollout` that is rolled back by this `Rollout`.
 Empty if this `Rollout` wasn't created as a rollback.
      string rollback_of_rollout = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for rollbackOfRollout.

    • getRolledBackByRolloutsList

      List<String> getRolledBackByRolloutsList()
       Output only. Names of `Rollouts` that rolled back this `Rollout`.
      repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the rolledBackByRollouts.

    • getRolledBackByRolloutsCount

      int getRolledBackByRolloutsCount()
       Output only. Names of `Rollouts` that rolled back this `Rollout`.
      repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of rolledBackByRollouts.

    • getRolledBackByRollouts

      String getRolledBackByRollouts(int index)
       Output only. Names of `Rollouts` that rolled back this `Rollout`.
      repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The rolledBackByRollouts at the given index.

    • getRolledBackByRolloutsBytes

      com.google.protobuf.ByteString getRolledBackByRolloutsBytes(int index)
       Output only. Names of `Rollouts` that rolled back this `Rollout`.
      repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the rolledBackByRollouts at the given index.

    • getActiveRepairAutomationRun

      String getActiveRepairAutomationRun()
       Output only. The AutomationRun actively repairing the rollout.
      string active_repair_automation_run = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The activeRepairAutomationRun.

    • getActiveRepairAutomationRunBytes

      com.google.protobuf.ByteString getActiveRepairAutomationRunBytes()
       Output only. The AutomationRun actively repairing the rollout.
      string active_repair_automation_run = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for activeRepairAutomationRun.