Class: Google::Cloud::Deploy::V1::AutomationRun

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/deploy/v1/cloud_deploy.rb

Overview

An AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#advance_rollout_operation ⇒ ::Google::Cloud::Deploy::V1::AdvanceRolloutOperation (readonly)

Returns Output only. Advances a rollout to the next phase.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#automation_id ⇒ ::String (readonly)

Returns Output only. The ID of the automation that initiated the operation.

Returns:

  • (::String) —

    Output only. The ID of the automation that initiated the operation.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#automation_snapshot ⇒ ::Google::Cloud::Deploy::V1::Automation (readonly)

Returns Output only. Snapshot of the Automation taken at AutomationRun creation time.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time at which the AutomationRun was created.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. The weak etag of the AutomationRun resource. 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.

Returns:

  • (::String) —

    Output only. The weak etag of the AutomationRun resource. 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.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Time the AutomationRun expires. An AutomationRun expires after 14 days from its creation date.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Returns:

  • (::String) —

    Output only. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#policy_violation ⇒ ::Google::Cloud::Deploy::V1::PolicyViolation (readonly)

Returns Output only. Contains information about what policies prevented the AutomationRun from proceeding.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#promote_release_operation ⇒ ::Google::Cloud::Deploy::V1::PromoteReleaseOperation (readonly)

Returns Output only. Promotes a release to a specified 'Target'.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#repair_rollout_operation ⇒ ::Google::Cloud::Deploy::V1::RepairRolloutOperation (readonly)

Returns Output only. Repairs a failed 'Rollout'.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#rule_id ⇒ ::String (readonly)

Returns Output only. The ID of the automation rule that initiated the operation.

Returns:

  • (::String) —

    Output only. The ID of the automation rule that initiated the operation.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#service_account ⇒ ::String (readonly)

Returns Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.

Returns:

  • (::String) —

    Output only. Email address of the user-managed IAM service account that performs the operations against Cloud Deploy resources.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#state ⇒ ::Google::Cloud::Deploy::V1::AutomationRun::State (readonly)

Returns Output only. Current state of the AutomationRun.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#state_description ⇒ ::String (readonly)

Returns Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.

Returns:

  • (::String) —

    Output only. Explains the current state of the AutomationRun. Present only when an explanation is needed.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#target_id ⇒ ::String (readonly)

Returns Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.

Returns:

  • (::String) —

    Output only. The ID of the source target that initiates the AutomationRun. The value of this field is the last segment of a target name.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#timed_promote_release_operation ⇒ ::Google::Cloud::Deploy::V1::TimedPromoteReleaseOperation (readonly)

Returns Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time at which the automationRun was updated.

Returns:



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end

#wait_until_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Earliest time the AutomationRun will attempt to resume. Wait-time is configured by wait in automation rule.



4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 4271

class AutomationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid state of an `AutomationRun`.
  module State
    # The `AutomationRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `AutomationRun` has succeeded.
    SUCCEEDED = 1

    # The `AutomationRun` was cancelled.
    CANCELLED = 2

    # The `AutomationRun` has failed.
    FAILED = 3

    # The `AutomationRun` is in progress.
    IN_PROGRESS = 4

    # The `AutomationRun` is pending.
    PENDING = 5

    # The `AutomationRun` was aborted.
    ABORTED = 6
  end
end