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.



4296
4297
4298
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4296

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


4173
4174
4175
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4173

def annotations
  @annotations
end

#approval_state ⇒ String

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

Returns:

  • (String) 


4178
4179
4180
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4178

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) 


4183
4184
4185
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4183

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) 


4190
4191
4192
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4190

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) 


4195
4196
4197
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4195

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) 


4200
4201
4202
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4200

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) 


4206
4207
4208
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4206

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) 


4211
4212
4213
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4211

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) 


4218
4219
4220
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4218

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) 


4223
4224
4225
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4223

def description
  @description
end

#enqueue_time ⇒ String

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

Returns:

  • (String) 


4228
4229
4230
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4228

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) 


4235
4236
4237
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4235

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) 


4240
4241
4242
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4240

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


4251
4252
4253
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4251

def labels
  @labels
end

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

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

Returns:



4256
4257
4258
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4256

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) 


4263
4264
4265
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4263

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:



4268
4269
4270
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4268

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) 


4274
4275
4276
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4274

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


4279
4280
4281
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4279

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) 


4284
4285
4286
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4284

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) 


4289
4290
4291
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4289

def target_id
  @target_id
end

#uid ⇒ String

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

Returns:

  • (String) 


4294
4295
4296
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4294

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 4301

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