public static final class Rollout.Builder extends GeneratedMessageV3.Builder<Rollout.Builder> implements RolloutOrBuilderRepresents a single rollout execution and its results
Protobuf type google.cloud.saasplatform.saasservicemgmt.v1beta1.Rollout
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rollout.BuilderImplements
RolloutOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Rollout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
build()
public Rollout build()| Returns | |
|---|---|
| Type | Description |
Rollout |
|
buildPartial()
public Rollout buildPartial()| Returns | |
|---|---|
| Type | Description |
Rollout |
|
clear()
public Rollout.Builder clear()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
clearAnnotations()
public Rollout.Builder clearAnnotations()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
clearControl()
public Rollout.Builder clearControl()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 |
Rollout.Builder |
|
clearCreateTime()
public Rollout.Builder clearCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
clearEndTime()
public Rollout.Builder clearEndTime()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 |
Rollout.Builder |
|
clearEtag()
public Rollout.Builder clearEtag()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 |
Rollout.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Rollout.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
clearLabels()
public Rollout.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
clearName()
public Rollout.Builder clearName()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 |
Rollout.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Rollout.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
clearParentRollout()
public Rollout.Builder clearParentRollout()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 |
Rollout.Builder |
This builder for chaining. |
clearRelease()
public Rollout.Builder clearRelease()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 |
Rollout.Builder |
This builder for chaining. |
clearRolloutKind()
public Rollout.Builder clearRolloutKind()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 |
Rollout.Builder |
This builder for chaining. |
clearRolloutOrchestrationStrategy()
public Rollout.Builder clearRolloutOrchestrationStrategy()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 |
Rollout.Builder |
This builder for chaining. |
clearRootRollout()
public Rollout.Builder clearRootRollout()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 |
Rollout.Builder |
This builder for chaining. |
clearStartTime()
public Rollout.Builder clearStartTime()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 |
Rollout.Builder |
|
clearState()
public Rollout.Builder clearState()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.Builder |
This builder for chaining. |
clearStateMessage()
public Rollout.Builder clearStateMessage()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 |
Rollout.Builder |
This builder for chaining. |
clearStateTransitionTime()
public Rollout.Builder clearStateTransitionTime()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 |
Rollout.Builder |
|
clearStats()
public Rollout.Builder clearStats()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 |
Rollout.Builder |
|
clearUid()
public Rollout.Builder clearUid()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 |
Rollout.Builder |
This builder for chaining. |
clearUnitFilter()
public Rollout.Builder clearUnitFilter()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 |
Rollout.Builder |
This builder for chaining. |
clearUpdateTime()
public Rollout.Builder clearUpdateTime()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 |
Rollout.Builder |
|
clone()
public Rollout.Builder clone()| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
containsAnnotations(String key)
public 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 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 Map<String,String> getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
public 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 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 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 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 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. |
getControlBuilder()
public RolloutControl.Builder getControlBuilder()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.Builder |
|
getControlOrBuilder()
public 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public Rollout getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Rollout |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEndTime()
public 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. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()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 |
Builder |
|
getEndTimeOrBuilder()
public 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 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 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 Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public 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 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 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 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 |
|
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public 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 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 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 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 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 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 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 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 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 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 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 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 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. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()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 |
Builder |
|
getStartTimeOrBuilder()
public 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 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 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 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 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. |
getStateTransitionTimeBuilder()
public Timestamp.Builder getStateTransitionTimeBuilder()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 |
Builder |
|
getStateTransitionTimeOrBuilder()
public 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 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 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. |
getStatsBuilder()
public RolloutStats.Builder getStatsBuilder()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.Builder |
|
getStatsOrBuilder()
public 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 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 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 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
getUpdateTimeOrBuilder()
public 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeControl(RolloutControl value)
public Rollout.Builder mergeControl(RolloutControl value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RolloutControl |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeCreateTime(Timestamp value)
public Rollout.Builder mergeCreateTime(Timestamp value)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeEndTime(Timestamp value)
public Rollout.Builder mergeEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeFrom(Rollout other)
public Rollout.Builder mergeFrom(Rollout other)| Parameter | |
|---|---|
| Name | Description |
other |
Rollout |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Rollout.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Rollout.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeStartTime(Timestamp value)
public Rollout.Builder mergeStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeStateTransitionTime(Timestamp value)
public Rollout.Builder mergeStateTransitionTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeStats(RolloutStats value)
public Rollout.Builder mergeStats(RolloutStats value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RolloutStats |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Rollout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
mergeUpdateTime(Timestamp value)
public Rollout.Builder mergeUpdateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
putAllAnnotations(Map<String,String> values)
public Rollout.Builder putAllAnnotations(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
putAllLabels(Map<String,String> values)
public Rollout.Builder putAllLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
putAnnotations(String key, String value)
public Rollout.Builder putAnnotations(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
putLabels(String key, String value)
public Rollout.Builder putLabels(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
removeAnnotations(String key)
public Rollout.Builder removeAnnotations(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 |
Rollout.Builder |
|
removeLabels(String key)
public Rollout.Builder removeLabels(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 |
Rollout.Builder |
|
setControl(RolloutControl value)
public Rollout.Builder setControl(RolloutControl value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RolloutControl |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setControl(RolloutControl.Builder builderForValue)
public Rollout.Builder setControl(RolloutControl.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RolloutControl.Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setCreateTime(Timestamp value)
public Rollout.Builder setCreateTime(Timestamp value)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Rollout.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 10303 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setEndTime(Timestamp value)
public Rollout.Builder setEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setEndTime(Timestamp.Builder builderForValue)
public Rollout.Builder setEndTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setEtag(String value)
public Rollout.Builder setEtag(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Rollout.Builder setEtagBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Rollout.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setName(String value)
public Rollout.Builder setName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Rollout.Builder setNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setParentRollout(String value)
public Rollout.Builder setParentRollout(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parentRollout to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setParentRolloutBytes(ByteString value)
public Rollout.Builder setParentRolloutBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parentRollout to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRelease(String value)
public Rollout.Builder setRelease(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe release to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setReleaseBytes(ByteString value)
public Rollout.Builder setReleaseBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for release to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Rollout.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setRolloutKind(String value)
public Rollout.Builder setRolloutKind(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe rolloutKind to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRolloutKindBytes(ByteString value)
public Rollout.Builder setRolloutKindBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for rolloutKind to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRolloutOrchestrationStrategy(String value)
public Rollout.Builder setRolloutOrchestrationStrategy(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe rolloutOrchestrationStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRolloutOrchestrationStrategyBytes(ByteString value)
public Rollout.Builder setRolloutOrchestrationStrategyBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for rolloutOrchestrationStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRootRollout(String value)
public Rollout.Builder setRootRollout(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe rootRollout to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setRootRolloutBytes(ByteString value)
public Rollout.Builder setRootRolloutBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for rootRollout to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setStartTime(Timestamp value)
public Rollout.Builder setStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setStartTime(Timestamp.Builder builderForValue)
public Rollout.Builder setStartTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setState(Rollout.RolloutState value)
public Rollout.Builder setState(Rollout.RolloutState value)Output only. Current state of the rollout.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Rollout.RolloutState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Rollout.RolloutStateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setStateMessage(String value)
public Rollout.Builder setStateMessage(String value)Output only. Human readable message indicating details about the last state transition.
string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe stateMessage to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setStateMessageBytes(ByteString value)
public Rollout.Builder setStateMessageBytes(ByteString value)Output only. Human readable message indicating details about the last state transition.
string state_message = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for stateMessage to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setStateTransitionTime(Timestamp value)
public Rollout.Builder setStateTransitionTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setStateTransitionTime(Timestamp.Builder builderForValue)
public Rollout.Builder setStateTransitionTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setStateValue(int value)
public Rollout.Builder setStateValue(int value)Output only. Current state of the rollout.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.Rollout.RolloutState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setStats(RolloutStats value)
public Rollout.Builder setStats(RolloutStats value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RolloutStats |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setStats(RolloutStats.Builder builderForValue)
public Rollout.Builder setStats(RolloutStats.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RolloutStats.Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setUid(String value)
public Rollout.Builder setUid(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public Rollout.Builder setUidBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setUnitFilter(String value)
public Rollout.Builder setUnitFilter(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe unitFilter to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setUnitFilterBytes(ByteString value)
public Rollout.Builder setUnitFilterBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for unitFilter to set. |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Rollout.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setUpdateTime(Timestamp value)
public Rollout.Builder setUpdateTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Rollout.Builder setUpdateTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Rollout.Builder |
|