Interface RolloutKindOrBuilder (0.2.0) 

public interface RolloutKindOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

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

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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

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

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

Returns
Type Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

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

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

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

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

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

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

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

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

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

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

Returns
Type Description
TimestampOrBuilder

getErrorBudget()

public abstract 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 abstract 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 abstract String getEtag()

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

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

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

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

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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

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

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

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

"projects/{project}/locations/{___location}/rolloutKinds/{rollout_kind_id}"

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

"projects/{project}/locations/{___location}/rolloutKinds/{rollout_kind_id}"

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

Returns
Type Description
ByteString

The bytes for name.

getRolloutOrchestrationStrategy()

public abstract 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 abstract 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 abstract String getUid()

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

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

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

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

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

Returns
Type Description
ByteString

The bytes for uid.

getUnitFilter()

public abstract String getUnitFilter()

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

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

Returns
Type Description
String

The unitFilter.

getUnitFilterBytes()

public abstract ByteString getUnitFilterBytes()

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

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

Returns
Type Description
ByteString

The bytes for unitFilter.

getUnitKind()

public abstract 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 abstract 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 abstract Timestamp getUpdateTime()

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

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getUpdateUnitKindStrategy()

public abstract 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 abstract 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 abstract boolean hasCreateTime()

Output only. The timestamp when the resource was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasErrorBudget()

public abstract 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 abstract boolean hasUpdateTime()

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

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

Returns
Type Description
boolean

Whether the updateTime field is set.