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.



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

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


2490
2491
2492
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2490

def annotations
  @annotations
end

#approval_state ⇒ String

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

Returns:

  • (String) 


2495
2496
2497
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2495

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) 


2500
2501
2502
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2500

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) 


2507
2508
2509
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2507

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) 


2512
2513
2514
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2512

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) 


2517
2518
2519
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2517

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) 


2523
2524
2525
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2523

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) 


2528
2529
2530
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2528

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) 


2535
2536
2537
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2535

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) 


2540
2541
2542
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2540

def description
  @description
end

#enqueue_time ⇒ String

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

Returns:

  • (String) 


2545
2546
2547
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2545

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) 


2552
2553
2554
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2552

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) 


2557
2558
2559
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2557

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


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

def labels
  @labels
end

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

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

Returns:



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

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) 


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

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:



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

def phases
  @phases
end

#state ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def target_id
  @target_id
end

#uid ⇒ String

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

Returns:

  • (String) 


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

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2607

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