Class RolloutKind (0.2.0) 

public final class RolloutKind extends GeneratedMessageV3 implements RolloutKindOrBuilder

An 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RolloutKind

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_BUDGET_FIELD_NUMBER

public static final int ERROR_BUDGET_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_ORCHESTRATION_STRATEGY_FIELD_NUMBER

public static final int ROLLOUT_ORCHESTRATION_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UNIT_FILTER_FIELD_NUMBER

public static final int UNIT_FILTER_FIELD_NUMBER
Field Value
Type Description
int

UNIT_KIND_FIELD_NUMBER

public static final int UNIT_KIND_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_UNIT_KIND_STRATEGY_FIELD_NUMBER

public static final int UPDATE_UNIT_KIND_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RolloutKind getDefaultInstance()
Returns
Type Description
RolloutKind

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RolloutKind.Builder newBuilder()
Returns
Type Description
RolloutKind.Builder

newBuilder(RolloutKind prototype)

public static RolloutKind.Builder newBuilder(RolloutKind prototype)
Parameter
Name Description
prototype RolloutKind
Returns
Type Description
RolloutKind.Builder

parseDelimitedFrom(InputStream input)

public static RolloutKind parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RolloutKind
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RolloutKind parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutKind
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RolloutKind parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RolloutKind
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RolloutKind parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutKind
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RolloutKind parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RolloutKind
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RolloutKind parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutKind
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RolloutKind parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RolloutKind
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RolloutKind parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutKind
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RolloutKind parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RolloutKind
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RolloutKind parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutKind
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RolloutKind parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RolloutKind
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RolloutKind parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RolloutKind
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RolloutKind> parser()
Returns
Type Description
Parser<RolloutKind>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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

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.

getParserForType()

public Parser<RolloutKind> getParserForType()
Returns
Type Description
Parser<RolloutKind>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RolloutKind.Builder newBuilderForType()
Returns
Type Description
RolloutKind.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RolloutKind.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RolloutKind.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RolloutKind.Builder toBuilder()
Returns
Type Description
RolloutKind.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException