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.



1385
1386
1387
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1385

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


1290
1291
1292
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1290

def annotations
  @annotations
end

#approval_state ⇒ String

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

Returns:

  • (String) 


1295
1296
1297
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1295

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) 


1300
1301
1302
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1300

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) 


1305
1306
1307
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1305

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) 


1310
1311
1312
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1310

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) 


1316
1317
1318
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1316

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) 


1321
1322
1323
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1321

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) 


1328
1329
1330
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1328

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) 


1333
1334
1335
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1333

def description
  @description
end

#enqueue_time ⇒ String

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

Returns:

  • (String) 


1338
1339
1340
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1338

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) 


1345
1346
1347
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1345

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) 


1350
1351
1352
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1350

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


1361
1362
1363
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1361

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) 


1368
1369
1370
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1368

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


1373
1374
1375
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1373

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) 


1378
1379
1380
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1378

def target_id
  @target_id
end

#uid ⇒ String

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

Returns:

  • (String) 


1383
1384
1385
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1383

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1390

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