Class: Google::Apis::ClouddeployV1::Rollout

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

Overview

A Rollout resource in the Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Rollout

Returns a new instance of Rollout.



5004
5005
5006
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 5004

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

Instance Attribute Details

#active_repair_automation_run ⇒ String

Output only. The AutomationRun actively repairing the rollout. Corresponds to the JSON property activeRepairAutomationRun

Returns:

  • (String) 


4874
4875
4876
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4874

def active_repair_automation_run
  @active_repair_automation_run
end

#annotations ⇒ Hash<String,String>

User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


4881
4882
4883
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4881

def annotations
  @annotations
end

#approval_state ⇒ String

Output only. Approval state of the Rollout. Corresponds to the JSON property approvalState

Returns:

  • (String) 


4886
4887
4888
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4886

def approval_state
  @approval_state
end

#approve_time ⇒ String

Output only. Time at which the Rollout was approved. Corresponds to the JSON property approveTime

Returns:

  • (String) 


4891
4892
4893
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4891

def approve_time
  @approve_time
end

#controller_rollout ⇒ String

Output only. Name of the ControllerRollout. Format is projects/project/ locations/location/deliveryPipelines/deliveryPipeline/releases/release/ rollouts/rollout`. Corresponds to the JSON propertycontrollerRollout`

Returns:

  • (String) 


4898
4899
4900
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4898

def controller_rollout
  @controller_rollout
end

#create_time ⇒ String

Output only. Time at which the Rollout was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4903
4904
4905
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4903

def create_time
  @create_time
end

#deploy_end_time ⇒ String

Output only. Time at which the Rollout finished deploying. Corresponds to the JSON property deployEndTime

Returns:

  • (String) 


4908
4909
4910
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4908

def deploy_end_time
  @deploy_end_time
end

#deploy_failure_cause ⇒ String

Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. Corresponds to the JSON property deployFailureCause

Returns:

  • (String) 


4914
4915
4916
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4914

def deploy_failure_cause
  @deploy_failure_cause
end

#deploy_start_time ⇒ String

Output only. Time at which the Rollout started deploying. Corresponds to the JSON property deployStartTime

Returns:

  • (String) 


4919
4920
4921
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4919

def deploy_start_time
  @deploy_start_time
end

#deploying_build ⇒ String

Output only. The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/project/locations/location/ builds/build`. Corresponds to the JSON propertydeployingBuild`

Returns:

  • (String) 


4926
4927
4928
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4926

def deploying_build
  @deploying_build
end

#description ⇒ String

Description of the Rollout for user purposes. Max length is 255 characters. Corresponds to the JSON property description

Returns:

  • (String) 


4931
4932
4933
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4931

def description
  @description
end

#enqueue_time ⇒ String

Output only. Time at which the Rollout was enqueued. Corresponds to the JSON property enqueueTime

Returns:

  • (String) 


4936
4937
4938
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4936

def enqueue_time
  @enqueue_time
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up- to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


4943
4944
4945
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4943

def etag
  @etag
end

#failure_reason ⇒ String

Output only. Additional information about the rollout failure, if available. Corresponds to the JSON property failureReason

Returns:

  • (String) 


4948
4949
4950
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4948

def failure_reason
  @failure_reason
end

#labels ⇒ Hash<String,String>

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character.

  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4959
4960
4961
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4959

def labels
  @labels
end

#metadata ⇒ Google::Apis::ClouddeployV1::Metadata

Metadata includes information associated with a Rollout. Corresponds to the JSON property metadata

Returns:



4964
4965
4966
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4964

def metadata
  @metadata
end

#name ⇒ String

Optional. Name of the Rollout. Format is projects/project/locations/ location/deliveryPipelines/deliveryPipeline/releases/release/rollouts/ rollout`. Therolloutcomponent must matcha-z? Corresponds to the JSON propertyname`

Returns:

  • (String) 


4971
4972
4973
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4971

def name
  @name
end

#phases ⇒ Array<Google::Apis::ClouddeployV1::Phase>

Output only. The phases that represent the workflows of this Rollout. Corresponds to the JSON property phases

Returns:



4976
4977
4978
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4976

def phases
  @phases
end

#rollback_of_rollout ⇒ String

Output only. Name of the Rollout that is rolled back by this Rollout. Empty if this Rollout wasn't created as a rollback. Corresponds to the JSON property rollbackOfRollout

Returns:

  • (String) 


4982
4983
4984
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4982

def rollback_of_rollout
  @rollback_of_rollout
end

#rolled_back_by_rollouts ⇒ Array<String>

Output only. Names of Rollouts that rolled back this Rollout. Corresponds to the JSON property rolledBackByRollouts

Returns:

  • (Array<String>) 


4987
4988
4989
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4987

def rolled_back_by_rollouts
  @rolled_back_by_rollouts
end

#state ⇒ String

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

Returns:

  • (String) 


4992
4993
4994
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4992

def state
  @state
end

#target_id ⇒ String

Required. The ID of Target to which this Rollout is deploying. Corresponds to the JSON property targetId

Returns:

  • (String) 


4997
4998
4999
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4997

def target_id
  @target_id
end

#uid ⇒ String

Output only. Unique identifier of the Rollout. Corresponds to the JSON property uid

Returns:

  • (String) 


5002
5003
5004
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 5002

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 5009

def update!(**args)
  @active_repair_automation_run = args[:active_repair_automation_run] if args.key?(:active_repair_automation_run)
  @annotations = args[:annotations] if args.key?(:annotations)
  @approval_state = args[:approval_state] if args.key?(:approval_state)
  @approve_time = args[:approve_time] if args.key?(:approve_time)
  @controller_rollout = args[:controller_rollout] if args.key?(:controller_rollout)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deploy_end_time = args[:deploy_end_time] if args.key?(:deploy_end_time)
  @deploy_failure_cause = args[:deploy_failure_cause] if args.key?(:deploy_failure_cause)
  @deploy_start_time = args[:deploy_start_time] if args.key?(:deploy_start_time)
  @deploying_build = args[:deploying_build] if args.key?(:deploying_build)
  @description = args[:description] if args.key?(:description)
  @enqueue_time = args[:enqueue_time] if args.key?(:enqueue_time)
  @etag = args[:etag] if args.key?(:etag)
  @failure_reason = args[:failure_reason] if args.key?(:failure_reason)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @phases = args[:phases] if args.key?(:phases)
  @rollback_of_rollout = args[:rollback_of_rollout] if args.key?(:rollback_of_rollout)
  @rolled_back_by_rollouts = args[:rolled_back_by_rollouts] if args.key?(:rolled_back_by_rollouts)
  @state = args[:state] if args.key?(:state)
  @target_id = args[:target_id] if args.key?(:target_id)
  @uid = args[:uid] if args.key?(:uid)
end