com.google.cloud.deploy.v1.RolloutOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-deploy-v1 Show documentation
Show all versions of proto-google-cloud-deploy-v1 Show documentation
Proto library for google-cloud-deploy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/deploy/v1/cloud_deploy.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.deploy.v1;
public interface RolloutOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.deploy.v1.Rollout)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. 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) = OPTIONAL];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Optional. 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) = OPTIONAL];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Unique identifier of the `Rollout`.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. Unique identifier of the `Rollout`.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Description of the `Rollout` for user purposes. Max length is 255
* characters.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Description of the `Rollout` for user purposes. Max length is 255
* characters.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* 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;
*/
int getAnnotationsCount();
/**
*
*
*
* 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;
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* 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;
*/
java.util.Map getAnnotationsMap();
/**
*
*
*
* 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;
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* 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;
*/
java.lang.String getAnnotationsOrThrow(java.lang.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;
*/
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;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. Time at which the `Rollout` was created.
*
*
* .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Time at which the `Rollout` was created.
*
*
* .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Time at which the `Rollout` was approved.
*
*
* .google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the approveTime field is set.
*/
boolean hasApproveTime();
/**
*
*
*
* Output only. Time at which the `Rollout` was approved.
*
*
* .google.protobuf.Timestamp approve_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The approveTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getApproveTimeOrBuilder();
/**
*
*
*
* Output only. Time at which the `Rollout` was enqueued.
*
*
* .google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the enqueueTime field is set.
*/
boolean hasEnqueueTime();
/**
*
*
*
* Output only. Time at which the `Rollout` was enqueued.
*
*
* .google.protobuf.Timestamp enqueue_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enqueueTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getEnqueueTimeOrBuilder();
/**
*
*
*
* Output only. Time at which the `Rollout` started deploying.
*
*
*
* .google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deployStartTime field is set.
*/
boolean hasDeployStartTime();
/**
*
*
*
* Output only. Time at which the `Rollout` started deploying.
*
*
*
* .google.protobuf.Timestamp deploy_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The deployStartTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getDeployStartTimeOrBuilder();
/**
*
*
*
* Output only. Time at which the `Rollout` finished deploying.
*
*
*
* .google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deployEndTime field is set.
*/
boolean hasDeployEndTime();
/**
*
*
*
* Output only. Time at which the `Rollout` finished deploying.
*
*
*
* .google.protobuf.Timestamp deploy_end_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The deployEndTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getDeployEndTimeOrBuilder();
/**
*
*
*
* Required. The ID of Target to which this `Rollout` is deploying.
*
*
* string target_id = 18 [(.google.api.field_behavior) = REQUIRED];
*
* @return The targetId.
*/
java.lang.String getTargetId();
/**
*
*
*
* Required. The ID of Target to which this `Rollout` is deploying.
*
*
* string target_id = 18 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for targetId.
*/
com.google.protobuf.ByteString getTargetIdBytes();
/**
*
*
*
* Output only. Approval state of the `Rollout`.
*
*
*
* .google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for approvalState.
*/
int getApprovalStateValue();
/**
*
*
*
* Output only. Approval state of the `Rollout`.
*
*
*
* .google.cloud.deploy.v1.Rollout.ApprovalState approval_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The approvalState.
*/
com.google.cloud.deploy.v1.Rollout.ApprovalState getApprovalState();
/**
*
*
*
* Output only. Current state of the `Rollout`.
*
*
*
* .google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. Current state of the `Rollout`.
*
*
*
* .google.cloud.deploy.v1.Rollout.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.deploy.v1.Rollout.State getState();
/**
*
*
*
* Output only. Additional information about the rollout failure, if
* available.
*
*
* string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The failureReason.
*/
java.lang.String getFailureReason();
/**
*
*
*
* Output only. Additional information about the rollout failure, if
* available.
*
*
* string failure_reason = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for failureReason.
*/
com.google.protobuf.ByteString getFailureReasonBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The deployingBuild.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for deployingBuild.
*/
com.google.protobuf.ByteString getDeployingBuildBytes();
/**
*
*
*
* 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;
*
* @return The etag.
*/
java.lang.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;
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for deployFailureCause.
*/
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];
*
*
* @return The deployFailureCause.
*/
com.google.cloud.deploy.v1.Rollout.FailureCause getDeployFailureCause();
/**
*
*
*
* 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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.deploy.v1.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];
*
*/
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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.deploy.v1.PhaseOrBuilder getPhasesOrBuilder(int index);
/**
*
*
*
* Output only. Metadata contains information about the rollout.
*
*
*
* .google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
*
*
* Output only. Metadata contains information about the rollout.
*
*
*
* .google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The metadata.
*/
com.google.cloud.deploy.v1.Metadata getMetadata();
/**
*
*
*
* Output only. Metadata contains information about the rollout.
*
*
*
* .google.cloud.deploy.v1.Metadata metadata = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.deploy.v1.MetadataOrBuilder getMetadataOrBuilder();
/**
*
*
*
* 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];
*
* @return The controllerRollout.
*/
java.lang.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];
*
* @return The bytes for controllerRollout.
*/
com.google.protobuf.ByteString getControllerRolloutBytes();
/**
*
*
*
* 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];
*
* @return The rollbackOfRollout.
*/
java.lang.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];
*
* @return The bytes for rollbackOfRollout.
*/
com.google.protobuf.ByteString getRollbackOfRolloutBytes();
/**
*
*
*
* Output only. Names of `Rollouts` that rolled back this `Rollout`.
*
*
*
* repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return A list containing the rolledBackByRollouts.
*/
java.util.List getRolledBackByRolloutsList();
/**
*
*
*
* Output only. Names of `Rollouts` that rolled back this `Rollout`.
*
*
*
* repeated string rolled_back_by_rollouts = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The count of rolledBackByRollouts.
*/
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];
*
*
* @param index The index of the element to return.
* @return The rolledBackByRollouts at the given index.
*/
java.lang.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];
*
*
* @param index The index of the value to return.
* @return The bytes of the rolledBackByRollouts at the given index.
*/
com.google.protobuf.ByteString getRolledBackByRolloutsBytes(int index);
}