SaaS Runtime V1BETA1 API - Class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind (v0.1.0)

Reference documentation and code samples for the SaaS Runtime V1BETA1 API class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind.

An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#error_budget

def error_budget() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ErrorBudget
Returns
  • (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ErrorBudget) — 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.

#error_budget=

def error_budget=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ErrorBudget
Parameter
  • value (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ErrorBudget) — 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.
Returns
  • (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ErrorBudget) — 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.

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name (full URI of the resource) following the standard naming scheme:

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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The resource name (full URI of the resource) following the standard naming scheme:

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

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

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

#rollout_orchestration_strategy

def rollout_orchestration_strategy() -> ::String
Returns
  • (::String) — 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.

#rollout_orchestration_strategy=

def rollout_orchestration_strategy=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#uid

def uid() -> ::String
Returns
  • (::String) — 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.

#unit_filter

def unit_filter() -> ::String
Returns
  • (::String) — 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.

#unit_filter=

def unit_filter=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#unit_kind

def unit_kind() -> ::String
Returns
  • (::String) — 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.

#unit_kind=

def unit_kind=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#update_unit_kind_strategy

def update_unit_kind_strategy() -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind::UpdateUnitKindStrategy
Returns

#update_unit_kind_strategy=

def update_unit_kind_strategy=(value) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind::UpdateUnitKindStrategy
Parameter
Returns