public static final class RolloutKind.Builder extends GeneratedMessageV3.Builder<RolloutKind.Builder> implements RolloutKindOrBuilderAn object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.
Protobuf type google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutKind
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RolloutKind.BuilderImplements
RolloutKindOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RolloutKind.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
build()
public RolloutKind build()| Returns | |
|---|---|
| Type | Description |
RolloutKind |
|
buildPartial()
public RolloutKind buildPartial()| Returns | |
|---|---|
| Type | Description |
RolloutKind |
|
clear()
public RolloutKind.Builder clear()| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
clearAnnotations()
public RolloutKind.Builder clearAnnotations()| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
clearCreateTime()
public RolloutKind.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 |
RolloutKind.Builder |
|
clearErrorBudget()
public RolloutKind.Builder clearErrorBudget()Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
clearEtag()
public RolloutKind.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 |
RolloutKind.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public RolloutKind.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
clearLabels()
public RolloutKind.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
clearName()
public RolloutKind.Builder clearName()Identifier. The resource name (full URI of the resource) following the standard naming scheme:
"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public RolloutKind.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
clearRolloutOrchestrationStrategy()
public RolloutKind.Builder clearRolloutOrchestrationStrategy()Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
string rollout_orchestration_strategy = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
clearUid()
public RolloutKind.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 |
RolloutKind.Builder |
This builder for chaining. |
clearUnitFilter()
public RolloutKind.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.
string unit_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
clearUnitKind()
public RolloutKind.Builder clearUnitKind()Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
string unit_kind = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
clearUpdateTime()
public RolloutKind.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 |
RolloutKind.Builder |
|
clearUpdateUnitKindStrategy()
public RolloutKind.Builder clearUpdateUnitKindStrategy()Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutKind.UpdateUnitKindStrategy update_unit_kind_strategy = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
clone()
public RolloutKind.Builder clone()| Returns | |
|---|---|
| Type | Description |
RolloutKind.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 |
|
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 RolloutKind getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RolloutKind |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getErrorBudget()
public ErrorBudget getErrorBudget()Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ErrorBudget |
The errorBudget. |
getErrorBudgetBuilder()
public ErrorBudget.Builder getErrorBudgetBuilder()Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ErrorBudget.Builder |
|
getErrorBudgetOrBuilder()
public ErrorBudgetOrBuilder getErrorBudgetOrBuilder()Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ErrorBudgetOrBuilder |
|
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}/rolloutKinds/{rollout_kind_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}/rolloutKinds/{rollout_kind_id}"
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getRolloutOrchestrationStrategy()
public String getRolloutOrchestrationStrategy()Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
string rollout_orchestration_strategy = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The rolloutOrchestrationStrategy. |
getRolloutOrchestrationStrategyBytes()
public ByteString getRolloutOrchestrationStrategyBytes()Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
string rollout_orchestration_strategy = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for rolloutOrchestrationStrategy. |
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.
string unit_filter = 5 [(.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.
string unit_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for unitFilter. |
getUnitKind()
public String getUnitKind()Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
string unit_kind = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The unitKind. |
getUnitKindBytes()
public ByteString getUnitKindBytes()Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
string unit_kind = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for unitKind. |
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 |
|
getUpdateUnitKindStrategy()
public RolloutKind.UpdateUnitKindStrategy getUpdateUnitKindStrategy()Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutKind.UpdateUnitKindStrategy update_unit_kind_strategy = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RolloutKind.UpdateUnitKindStrategy |
The updateUnitKindStrategy. |
getUpdateUnitKindStrategyValue()
public int getUpdateUnitKindStrategyValue()Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutKind.UpdateUnitKindStrategy update_unit_kind_strategy = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for updateUnitKindStrategy. |
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. |
hasErrorBudget()
public boolean hasErrorBudget()Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the errorBudget 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 |
|
mergeCreateTime(Timestamp value)
public RolloutKind.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 |
RolloutKind.Builder |
|
mergeErrorBudget(ErrorBudget value)
public RolloutKind.Builder mergeErrorBudget(ErrorBudget value)Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ErrorBudget |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
mergeFrom(RolloutKind other)
public RolloutKind.Builder mergeFrom(RolloutKind other)| Parameter | |
|---|---|
| Name | Description |
other |
RolloutKind |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RolloutKind.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RolloutKind.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RolloutKind.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
mergeUpdateTime(Timestamp value)
public RolloutKind.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 |
RolloutKind.Builder |
|
putAllAnnotations(Map<String,String> values)
public RolloutKind.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 |
RolloutKind.Builder |
|
putAllLabels(Map<String,String> values)
public RolloutKind.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 |
RolloutKind.Builder |
|
putAnnotations(String key, String value)
public RolloutKind.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 |
RolloutKind.Builder |
|
putLabels(String key, String value)
public RolloutKind.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 |
RolloutKind.Builder |
|
removeAnnotations(String key)
public RolloutKind.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 |
RolloutKind.Builder |
|
removeLabels(String key)
public RolloutKind.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 |
RolloutKind.Builder |
|
setCreateTime(Timestamp value)
public RolloutKind.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 |
RolloutKind.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public RolloutKind.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 |
RolloutKind.Builder |
|
setErrorBudget(ErrorBudget value)
public RolloutKind.Builder setErrorBudget(ErrorBudget value)Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ErrorBudget |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
setErrorBudget(ErrorBudget.Builder builderForValue)
public RolloutKind.Builder setErrorBudget(ErrorBudget.Builder builderForValue)Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
optional .google.cloud.saasplatform.saasservicemgmt.v1beta1.ErrorBudget error_budget = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ErrorBudget.Builder |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
setEtag(String value)
public RolloutKind.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 |
RolloutKind.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public RolloutKind.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 |
RolloutKind.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public RolloutKind.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
setName(String value)
public RolloutKind.Builder setName(String value)Identifier. The resource name (full URI of the resource) following the standard naming scheme:
"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public RolloutKind.Builder setNameBytes(ByteString value)Identifier. The resource name (full URI of the resource) following the standard naming scheme:
"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RolloutKind.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
setRolloutOrchestrationStrategy(String value)
public RolloutKind.Builder setRolloutOrchestrationStrategy(String value)Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
string rollout_orchestration_strategy = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe rolloutOrchestrationStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setRolloutOrchestrationStrategyBytes(ByteString value)
public RolloutKind.Builder setRolloutOrchestrationStrategyBytes(ByteString value)Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
string rollout_orchestration_strategy = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for rolloutOrchestrationStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setUid(String value)
public RolloutKind.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 |
RolloutKind.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public RolloutKind.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 |
RolloutKind.Builder |
This builder for chaining. |
setUnitFilter(String value)
public RolloutKind.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.
string unit_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe unitFilter to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setUnitFilterBytes(ByteString value)
public RolloutKind.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.
string unit_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for unitFilter to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setUnitKind(String value)
public RolloutKind.Builder setUnitKind(String value)Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
string unit_kind = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe unitKind to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setUnitKindBytes(ByteString value)
public RolloutKind.Builder setUnitKindBytes(ByteString value)Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
string unit_kind = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for unitKind to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RolloutKind.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
|
setUpdateTime(Timestamp value)
public RolloutKind.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 |
RolloutKind.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public RolloutKind.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 |
RolloutKind.Builder |
|
setUpdateUnitKindStrategy(RolloutKind.UpdateUnitKindStrategy value)
public RolloutKind.Builder setUpdateUnitKindStrategy(RolloutKind.UpdateUnitKindStrategy value)Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutKind.UpdateUnitKindStrategy update_unit_kind_strategy = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
RolloutKind.UpdateUnitKindStrategyThe updateUnitKindStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |
setUpdateUnitKindStrategyValue(int value)
public RolloutKind.Builder setUpdateUnitKindStrategyValue(int value)Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
.google.cloud.saasplatform.saasservicemgmt.v1beta1.RolloutKind.UpdateUnitKindStrategy update_unit_kind_strategy = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for updateUnitKindStrategy to set. |
| Returns | |
|---|---|
| Type | Description |
RolloutKind.Builder |
This builder for chaining. |