Interface RolloutOrBuilder (0.2.0) 

public interface RolloutOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: https://kubernetes.io/docs/user-guide/annotations

map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: https://kubernetes.io/docs/user-guide/annotations

map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: https://kubernetes.io/docs/user-guide/annotations

map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: https://kubernetes.io/docs/user-guide/annotations

map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

More info: https://kubernetes.io/docs/user-guide/annotations

map<string, string> annotations = 10402 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getControl()

public abstract RolloutControl getControl()

Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl control = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutControl

The control.

getControlOrBuilder()

public abstract RolloutControlOrBuilder getControlOrBuilder()

Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl control = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutControlOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getEndTime()

public abstract Timestamp getEndTime()

Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getEtag()

public abstract String getEtag()

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

string etag = 10202 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

string etag = 10202 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

map<string, string> labels = 10401 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

Identifier. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/rollout/{rollout_id}"

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/rollout/{rollout_id}"

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParentRollout()

public abstract String getParentRollout()

Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/rollouts/{rollout_id}"

string parent_rollout = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parentRollout.

getParentRolloutBytes()

public abstract ByteString getParentRolloutBytes()

Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/rollouts/{rollout_id}"

string parent_rollout = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parentRollout.

getRelease()

public abstract String getRelease()

Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

string release = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The release.

getReleaseBytes()

public abstract ByteString getReleaseBytes()

Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

string release = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for release.

getRolloutKind()

public abstract String getRolloutKind()

Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

string rollout_kind = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The rolloutKind.

getRolloutKindBytes()

public abstract ByteString getRolloutKindBytes()

Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

string rollout_kind = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for rolloutKind.

getRolloutOrchestrationStrategy()

public abstract String getRolloutOrchestrationStrategy()

Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used.

There are two supported values strategies which are used to control

  • "Google.Cloud.Simple.AllAtOnce"

  • "Google.Cloud.Simple.OneLocationAtATime"

    A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.

string rollout_orchestration_strategy = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rolloutOrchestrationStrategy.

getRolloutOrchestrationStrategyBytes()

public abstract ByteString getRolloutOrchestrationStrategyBytes()

Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used.

There are two supported values strategies which are used to control

  • "Google.Cloud.Simple.AllAtOnce"

  • "Google.Cloud.Simple.OneLocationAtATime"

    A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.

string rollout_orchestration_strategy = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rolloutOrchestrationStrategy.

getRootRollout()

public abstract String getRootRollout()

Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/rollouts/{rollout_id}"

string root_rollout = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The rootRollout.

getRootRolloutBytes()

public abstract ByteString getRootRolloutBytes()

Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/rollouts/{rollout_id}"

string root_rollout = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for rootRollout.

getStartTime()

public abstract Timestamp getStartTime()

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public abstract Rollout.RolloutState getState()

Output only. Current state of the rollout.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Rollout.RolloutState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Rollout.RolloutState

The state.

getStateMessage()

public abstract String getStateMessage()

Output only. Human readable message indicating details about the last state transition.

string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateMessage.

getStateMessageBytes()

public abstract ByteString getStateMessageBytes()

Output only. Human readable message indicating details about the last state transition.

string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateMessage.

getStateTransitionTime()

public abstract Timestamp getStateTransitionTime()

Optional. Output only. The time when the rollout transitioned into its current state.

.google.protobuf.Timestamp state_transition_time = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The stateTransitionTime.

getStateTransitionTimeOrBuilder()

public abstract TimestampOrBuilder getStateTransitionTimeOrBuilder()

Optional. Output only. The time when the rollout transitioned into its current state.

.google.protobuf.Timestamp state_transition_time = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getStateValue()

public abstract int getStateValue()

Output only. Current state of the rollout.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.Rollout.RolloutState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStats()

public abstract RolloutStats getStats()

Optional. Output only. Details about the progress of the rollout.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutStats stats = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutStats

The stats.

getStatsOrBuilder()

public abstract RolloutStatsOrBuilder getStatsOrBuilder()

Optional. Output only. Details about the progress of the rollout.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutStats stats = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RolloutStatsOrBuilder

getUid()

public abstract String getUid()

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

string uid = 10201 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

string uid = 10201 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUnitFilter()

public abstract String getUnitFilter()

Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.

string unit_filter = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The unitFilter.

getUnitFilterBytes()

public abstract ByteString getUnitFilterBytes()

Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.

string unit_filter = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for unitFilter.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

.google.protobuf.Timestamp update_time = 10304 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

.google.protobuf.Timestamp update_time = 10304 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasControl()

public abstract boolean hasControl()

Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutControl control = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the control field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public abstract boolean hasEndTime()

Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public abstract boolean hasStartTime()

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasStateTransitionTime()

public abstract boolean hasStateTransitionTime()

Optional. Output only. The time when the rollout transitioned into its current state.

.google.protobuf.Timestamp state_transition_time = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stateTransitionTime field is set.

hasStats()

public abstract boolean hasStats()

Optional. Output only. Details about the progress of the rollout.

.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutStats stats = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the stats field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

.google.protobuf.Timestamp update_time = 10304 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.