Class: Google::Apis::SaasservicemgmtV1beta1::Rollout

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

Represents a single rollout execution and its results

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Rollout

Returns a new instance of Rollout.



1066
1067
1068
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1066

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>) 


926
927
928
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 926

def annotations
  @annotations
end

#control ⇒ Google::Apis::SaasservicemgmtV1beta1::RolloutControl

RolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it. Corresponds to the JSON property control

Returns:



932
933
934
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 932

def control
  @control
end

#create_time ⇒ String

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

Returns:

  • (String) 


937
938
939
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 937

def create_time
  @create_time
end

#effective_unit_filter ⇒ String

Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind. unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. Corresponds to the JSON property effectiveUnitFilter

Returns:

  • (String) 


947
948
949
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 947

def effective_unit_filter
  @effective_unit_filter
end

#end_time ⇒ String

Optional. Output only. The time when the rollout finished execution ( regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. Corresponds to the JSON property endTime

Returns:

  • (String) 


955
956
957
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 955

def end_time
  @end_time
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) 


962
963
964
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 962

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>) 


968
969
970
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 968

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


975
976
977
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 975

def name
  @name
end

#parent_rollout ⇒ String

Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/project/locations/location/rollouts/rollout_id" Corresponds to the JSON property parentRollout

Returns:

  • (String) 


982
983
984
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 982

def parent_rollout
  @parent_rollout
end

#release ⇒ String

Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. Corresponds to the JSON property release

Returns:

  • (String) 


988
989
990
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 988

def release
  @release
end

#rollout_kind ⇒ String

Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. Corresponds to the JSON property rolloutKind

Returns:

  • (String) 


994
995
996
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 994

def rollout_kind
  @rollout_kind
end

#rollout_orchestration_strategy ⇒ String

Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. 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 targeted UnitKind's Saas Locations. Corresponds to the JSON property rolloutOrchestrationStrategy

Returns:

  • (String) 


1005
1006
1007
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1005

def rollout_orchestration_strategy
  @rollout_orchestration_strategy
end

#root_rollout ⇒ String

Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/project/locations/location/rollouts/rollout_id" Corresponds to the JSON property rootRollout

Returns:

  • (String) 


1012
1013
1014
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1012

def root_rollout
  @root_rollout
end

#start_time ⇒ String

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. Corresponds to the JSON property startTime

Returns:

  • (String) 


1018
1019
1020
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1018

def start_time
  @start_time
end

#state ⇒ String

Output only. Current state of the rollout. Corresponds to the JSON property state

Returns:

  • (String) 


1023
1024
1025
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1023

def state
  @state
end

#state_message ⇒ String

Output only. Human readable message indicating details about the last state transition. Corresponds to the JSON property stateMessage

Returns:

  • (String) 


1029
1030
1031
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1029

def state_message
  @state_message
end

#state_transition_time ⇒ String

Optional. Output only. The time when the rollout transitioned into its current state. Corresponds to the JSON property stateTransitionTime

Returns:

  • (String) 


1035
1036
1037
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1035

def state_transition_time
  @state_transition_time
end

#stats ⇒ Google::Apis::SaasservicemgmtV1beta1::RolloutStats

RolloutStats contains information about the progress of a rollout. Corresponds to the JSON property stats

Returns:



1040
1041
1042
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1040

def stats
  @stats
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) 


1049
1050
1051
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1049

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. If not provided, the unit_filter from the RolloutKind will be used. Corresponds to the JSON property unitFilter

Returns:

  • (String) 


1057
1058
1059
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1057

def unit_filter
  @unit_filter
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) 


1064
1065
1066
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1064

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/google/apis/saasservicemgmt_v1beta1/classes.rb', line 1071

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @control = args[:control] if args.key?(:control)
  @create_time = args[:create_time] if args.key?(:create_time)
  @effective_unit_filter = args[:effective_unit_filter] if args.key?(:effective_unit_filter)
  @end_time = args[:end_time] if args.key?(:end_time)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent_rollout = args[:parent_rollout] if args.key?(:parent_rollout)
  @release = args[:release] if args.key?(:release)
  @rollout_kind = args[:rollout_kind] if args.key?(:rollout_kind)
  @rollout_orchestration_strategy = args[:rollout_orchestration_strategy] if args.key?(:rollout_orchestration_strategy)
  @root_rollout = args[:root_rollout] if args.key?(:root_rollout)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @state_message = args[:state_message] if args.key?(:state_message)
  @state_transition_time = args[:state_transition_time] if args.key?(:state_transition_time)
  @stats = args[:stats] if args.key?(:stats)
  @uid = args[:uid] if args.key?(:uid)
  @unit_filter = args[:unit_filter] if args.key?(:unit_filter)
  @update_time = args[:update_time] if args.key?(:update_time)
end