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.

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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

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

Returns:

  • (::String) —

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



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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.

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'proto_docs/google/cloud/deploy/v1/cloud_deploy.rb', line 2747

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