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.



1526
1527
1528
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1526

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


1431
1432
1433
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1431

def annotations
  @annotations
end

#approval_state ⇒ String

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

Returns:

  • (String) 


1436
1437
1438
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1436

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) 


1441
1442
1443
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1441

def approve_time
  @approve_time
end

#create_time ⇒ String

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

Returns:

  • (String) 


1446
1447
1448
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1446

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) 


1451
1452
1453
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1451

def deploy_end_time
  @deploy_end_time
end

#deploy_failure_cause ⇒ String

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

Returns:

  • (String) 


1457
1458
1459
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1457

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) 


1462
1463
1464
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1462

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) 


1469
1470
1471
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1469

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) 


1474
1475
1476
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1474

def description
  @description
end

#enqueue_time ⇒ String

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

Returns:

  • (String) 


1479
1480
1481
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1479

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) 


1486
1487
1488
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1486

def etag
  @etag
end

#failure_reason ⇒ String

Output only. Reason the build failed. Empty if the build succeeded. Corresponds to the JSON property failureReason

Returns:

  • (String) 


1491
1492
1493
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1491

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


1502
1503
1504
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1502

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


1509
1510
1511
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1509

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


1514
1515
1516
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1514

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) 


1519
1520
1521
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1519

def target_id
  @target_id
end

#uid ⇒ String

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

Returns:

  • (String) 


1524
1525
1526
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1524

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1531

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