Class: Google::Cloud::Deploy::V1::JobRun

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

A JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#advance_child_rollout_job_run ⇒ ::Google::Cloud::Deploy::V1::AdvanceChildRolloutJobRun (readonly)

Returns Output only. Information specific to an advanceChildRollout JobRun

Note: The following fields are mutually exclusive: advance_child_rollout_job_run, deploy_job_run, verify_job_run, predeploy_job_run, postdeploy_job_run, create_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Deploy::V1::AdvanceChildRolloutJobRun) —

    Output only. Information specific to an advanceChildRollout JobRun

    Note: The following fields are mutually exclusive: advance_child_rollout_job_run, deploy_job_run, verify_job_run, predeploy_job_run, postdeploy_job_run, create_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#create_child_rollout_job_run ⇒ ::Google::Cloud::Deploy::V1::CreateChildRolloutJobRun (readonly)

Returns Output only. Information specific to a createChildRollout JobRun.

Note: The following fields are mutually exclusive: create_child_rollout_job_run, deploy_job_run, verify_job_run, predeploy_job_run, postdeploy_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Deploy::V1::CreateChildRolloutJobRun) —

    Output only. Information specific to a createChildRollout JobRun.

    Note: The following fields are mutually exclusive: create_child_rollout_job_run, deploy_job_run, verify_job_run, predeploy_job_run, postdeploy_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

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

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

Returns:



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#deploy_job_run ⇒ ::Google::Cloud::Deploy::V1::DeployJobRun (readonly)

Returns Output only. Information specific to a deploy JobRun.

Note: The following fields are mutually exclusive: deploy_job_run, verify_job_run, predeploy_job_run, postdeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Deploy::V1::DeployJobRun) —

    Output only. Information specific to a deploy JobRun.

    Note: The following fields are mutually exclusive: deploy_job_run, verify_job_run, predeploy_job_run, postdeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

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

Returns Output only. Time at which the JobRun ended.

Returns:



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. 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. 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.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#job_id ⇒ ::String (readonly)

Returns Output only. ID of the Rollout job this JobRun corresponds to.

Returns:

  • (::String) —

    Output only. ID of the Rollout job this JobRun corresponds to.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Name of the JobRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.

Returns:

  • (::String) —

    Output only. Name of the JobRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#phase_id ⇒ ::String (readonly)

Returns Output only. ID of the Rollout phase this JobRun belongs in.

Returns:

  • (::String) —

    Output only. ID of the Rollout phase this JobRun belongs in.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#postdeploy_job_run ⇒ ::Google::Cloud::Deploy::V1::PostdeployJobRun (readonly)

Returns Output only. Information specific to a postdeploy JobRun.

Note: The following fields are mutually exclusive: postdeploy_job_run, deploy_job_run, verify_job_run, predeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Deploy::V1::PostdeployJobRun) —

    Output only. Information specific to a postdeploy JobRun.

    Note: The following fields are mutually exclusive: postdeploy_job_run, deploy_job_run, verify_job_run, predeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#predeploy_job_run ⇒ ::Google::Cloud::Deploy::V1::PredeployJobRun (readonly)

Returns Output only. Information specific to a predeploy JobRun.

Note: The following fields are mutually exclusive: predeploy_job_run, deploy_job_run, verify_job_run, postdeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Deploy::V1::PredeployJobRun) —

    Output only. Information specific to a predeploy JobRun.

    Note: The following fields are mutually exclusive: predeploy_job_run, deploy_job_run, verify_job_run, postdeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

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

Returns Output only. Time at which the JobRun was started.

Returns:



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

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

Returns Output only. The current state of the JobRun.

Returns:



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Unique identifier of the JobRun.

Returns:

  • (::String) —

    Output only. Unique identifier of the JobRun.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end

#verify_job_run ⇒ ::Google::Cloud::Deploy::V1::VerifyJobRun (readonly)

Returns Output only. Information specific to a verify JobRun.

Note: The following fields are mutually exclusive: verify_job_run, deploy_job_run, predeploy_job_run, postdeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Deploy::V1::VerifyJobRun) —

    Output only. Information specific to a verify JobRun.

    Note: The following fields are mutually exclusive: verify_job_run, deploy_job_run, predeploy_job_run, postdeploy_job_run, create_child_rollout_job_run, advance_child_rollout_job_run. If a field in that set is populated, all other fields in the set will automatically be cleared.



3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 3397

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

  # Valid states of a `JobRun`.
  module State
    # The `JobRun` has an unspecified state.
    STATE_UNSPECIFIED = 0

    # The `JobRun` is in progress.
    IN_PROGRESS = 1

    # The `JobRun` has succeeded.
    SUCCEEDED = 2

    # The `JobRun` has failed.
    FAILED = 3

    # The `JobRun` is terminating.
    TERMINATING = 4

    # The `JobRun` was terminated.
    TERMINATED = 5
  end
end