Class: Google::Apis::SaasservicemgmtV1beta1::RolloutKind

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/saasservicemgmt_v1beta1/classes.rb,
lib/google/apis/saasservicemgmt_v1beta1/representations.rb,
lib/google/apis/saasservicemgmt_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RolloutKind

Returns a new instance of RolloutKind.



1978
1979
1980
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1978

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotations ⇒ Hash<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 Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1898
1899
1900
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1898

def annotations
  @annotations
end

#create_time ⇒ String

Output only. The timestamp when the resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1903
1904
1905
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1903

def create_time
  @create_time
end

#error_budget ⇒ Google::Apis::SaasservicemgmtV1beta1::ErrorBudget

The configuration for error budget. If the number of failed units exceeds max( allowed_count, allowed_ratio * total_units), the rollout will be paused. Corresponds to the JSON property errorBudget

Returns:



1909
1910
1911
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1909

def error_budget
  @error_budget
end

#etag ⇒ 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. Corresponds to the JSON property etag

Returns:

  • (String) 


1916
1917
1918
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1916

def etag
  @etag
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1922
1923
1924
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1922

def labels
  @labels
end

#name ⇒ String

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/project/locations/location/rolloutKinds/ rollout_kind_id" Corresponds to the JSON property name

Returns:

  • (String) 


1929
1930
1931
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1929

def name
  @name
end

#rollout_orchestration_strategy ⇒ 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. Corresponds to the JSON property rolloutOrchestrationStrategy

Returns:

  • (String) 


1938
1939
1940
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1938

def rollout_orchestration_strategy
  @rollout_orchestration_strategy
end

#uid ⇒ 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. Corresponds to the JSON property uid

Returns:

  • (String) 


1947
1948
1949
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1947

def uid
  @uid
end

#unit_filter ⇒ 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. Corresponds to the JSON property unitFilter

Returns:

  • (String) 


1955
1956
1957
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1955

def unit_filter
  @unit_filter
end

#unit_kind ⇒ 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. Corresponds to the JSON property unitKind

Returns:

  • (String) 


1963
1964
1965
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1963

def unit_kind
  @unit_kind
end

#update_time ⇒ String

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. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1970
1971
1972
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1970

def update_time
  @update_time
end

#update_unit_kind_strategy ⇒ String

Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start. Corresponds to the JSON property updateUnitKindStrategy

Returns:

  • (String) 


1976
1977
1978
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1976

def update_unit_kind_strategy
  @update_unit_kind_strategy
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1983

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @create_time = args[:create_time] if args.key?(:create_time)
  @error_budget = args[:error_budget] if args.key?(:error_budget)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @rollout_orchestration_strategy = args[:rollout_orchestration_strategy] if args.key?(:rollout_orchestration_strategy)
  @uid = args[:uid] if args.key?(:uid)
  @unit_filter = args[:unit_filter] if args.key?(:unit_filter)
  @unit_kind = args[:unit_kind] if args.key?(:unit_kind)
  @update_time = args[:update_time] if args.key?(:update_time)
  @update_unit_kind_strategy = args[:update_unit_kind_strategy] if args.key?(:update_unit_kind_strategy)
end