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 Google 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.



2675
2676
2677
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2675

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

User annotations. These attributes can only be set and used by the user, and not by Google 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>) 


2563
2564
2565
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2563

def annotations
  @annotations
end

#approval_state ⇒ String

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

Returns:

  • (String) 


2568
2569
2570
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2568

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) 


2573
2574
2575
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2573

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/a-z0,62. Corresponds to the JSON property controllerRollout

Returns:

  • (String) 


2580
2581
2582
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2580

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) 


2585
2586
2587
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2585

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) 


2590
2591
2592
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2590

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) 


2596
2597
2598
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2596

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) 


2601
2602
2603
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2601

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) 


2608
2609
2610
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2608

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) 


2613
2614
2615
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2613

def description
  @description
end

#enqueue_time ⇒ String

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

Returns:

  • (String) 


2618
2619
2620
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2618

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) 


2625
2626
2627
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2625

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) 


2630
2631
2632
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2630

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


2641
2642
2643
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2641

def labels
  @labels
end

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

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

Returns:



2646
2647
2648
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2646

def metadata
  @metadata
end

#name ⇒ String

Optional. Name of the Rollout. Format is projects/project/ locations/ location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/a- z0,62. Corresponds to the JSON property name

Returns:

  • (String) 


2653
2654
2655
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2653

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:



2658
2659
2660
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2658

def phases
  @phases
end

#state ⇒ String

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

Returns:

  • (String) 


2663
2664
2665
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2663

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) 


2668
2669
2670
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2668

def target_id
  @target_id
end

#uid ⇒ String

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

Returns:

  • (String) 


2673
2674
2675
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2673

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2680

def update!(**args)
  @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)
  @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