Class: Google::Apis::SaasservicemgmtV1::Rollout

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/saasservicemgmt_v1/classes.rb,
lib/google/apis/saasservicemgmt_v1/representations.rb,
lib/google/apis/saasservicemgmt_v1/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.



915
916
917
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 915

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


761
762
763
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 761

def annotations
  @annotations
end

#control ⇒ Google::Apis::SaasservicemgmtV1::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:



767
768
769
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 767

def control
  @control
end

#create_time ⇒ String

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

Returns:

  • (String) 


772
773
774
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 772

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation). Corresponds to the JSON property deleteTime

Returns:

  • (String) 


778
779
780
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 778

def delete_time
  @delete_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) 


788
789
790
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 788

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) 


796
797
798
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 796

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) 


803
804
805
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 803

def etag
  @etag
end

#flag_release ⇒ String

Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: release comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. Corresponds to the JSON property flagRelease

Returns:

  • (String) 


811
812
813
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 811

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


817
818
819
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 817

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) 


824
825
826
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 824

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) 


831
832
833
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 831

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) 


837
838
839
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 837

def release
  @release
end

#rollout_kind ⇒ String

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

Returns:

  • (String) 


843
844
845
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 843

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) 


854
855
856
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 854

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) 


861
862
863
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 861

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) 


867
868
869
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 867

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


872
873
874
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 872

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) 


878
879
880
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 878

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) 


884
885
886
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 884

def state_transition_time
  @state_transition_time
end

#stats ⇒ Google::Apis::SaasservicemgmtV1::RolloutStats

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

Returns:



889
890
891
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 889

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) 


898
899
900
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 898

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) 


906
907
908
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 906

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) 


913
914
915
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 913

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/google/apis/saasservicemgmt_v1/classes.rb', line 920

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)
  @delete_time = args[:delete_time] if args.key?(:delete_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)
  @flag_release = args[:flag_release] if args.key?(:flag_release)
  @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