Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Job.
Job represents the configuration of a single job, which references a container image that is run to completion.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — Unstructured key value map that may
be set by external tools to store and arbitrary metadata.
They are not queryable and should be preserved
when modifying objects.
Cloud Run API v2 does not support annotations with
run.googleapis.com
,cloud.googleapis.com
,serving.knative.dev
, orautoscaling.knative.dev
namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.This field follows Kubernetes annotations' namespacing, limits, and rules.
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — Unstructured key value map that may
be set by external tools to store and arbitrary metadata.
They are not queryable and should be preserved
when modifying objects.
Cloud Run API v2 does not support annotations with
run.googleapis.com
,cloud.googleapis.com
,serving.knative.dev
, orautoscaling.knative.dev
namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.This field follows Kubernetes annotations' namespacing, limits, and rules.
-
(::Google::Protobuf::Map{::String => ::String}) — Unstructured key value map that may
be set by external tools to store and arbitrary metadata.
They are not queryable and should be preserved
when modifying objects.
Cloud Run API v2 does not support annotations with
run.googleapis.com
,cloud.googleapis.com
,serving.knative.dev
, orautoscaling.knative.dev
namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.This field follows Kubernetes annotations' namespacing, limits, and rules.
#binary_authorization
def binary_authorization() -> ::Google::Cloud::Run::V2::BinaryAuthorization
- (::Google::Cloud::Run::V2::BinaryAuthorization) — Settings for the Binary Authorization feature.
#binary_authorization=
def binary_authorization=(value) -> ::Google::Cloud::Run::V2::BinaryAuthorization
- value (::Google::Cloud::Run::V2::BinaryAuthorization) — Settings for the Binary Authorization feature.
- (::Google::Cloud::Run::V2::BinaryAuthorization) — Settings for the Binary Authorization feature.
#client
def client() -> ::String
- (::String) — Arbitrary identifier for the API client.
#client=
def client=(value) -> ::String
- value (::String) — Arbitrary identifier for the API client.
- (::String) — Arbitrary identifier for the API client.
#client_version
def client_version() -> ::String
- (::String) — Arbitrary version identifier for the API client.
#client_version=
def client_version=(value) -> ::String
- value (::String) — Arbitrary version identifier for the API client.
- (::String) — Arbitrary version identifier for the API client.
#conditions
def conditions() -> ::Array<::Google::Cloud::Run::V2::Condition>
-
(::Array<::Google::Cloud::Run::V2::Condition>) — Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in
reconciling
for additional information on reconciliation process in Cloud Run.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The creation time.
#creator
def creator() -> ::String
- (::String) — Output only. Email address of the authenticated creator.
#delete_time
def delete_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The deletion time.
#etag
def etag() -> ::String
- (::String) — Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
#execution_count
def execution_count() -> ::Integer
- (::Integer) — Output only. Number of executions created for this job.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. For a deleted resource, the time after which it will be permamently deleted.
#generation
def generation() -> ::Integer
- (::Integer) — Output only. A number that monotonically increases every time the user modifies the desired state.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — Unstructured key value map that can be used to organize and categorize
objects.
User-provided labels are shared with Google's billing system, so they can
be used to filter, or break down billing charges by team, component,
environment, state, etc. For more information, visit
https://cloud.google.com/resource-manager/docs/creating-managing-labels or
https://cloud.google.com/run/docs/configuring/labels.
Cloud Run API v2 does not support labels with
run.googleapis.com
,cloud.googleapis.com
,serving.knative.dev
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — Unstructured key value map that can be used to organize and categorize
objects.
User-provided labels are shared with Google's billing system, so they can
be used to filter, or break down billing charges by team, component,
environment, state, etc. For more information, visit
https://cloud.google.com/resource-manager/docs/creating-managing-labels or
https://cloud.google.com/run/docs/configuring/labels.
Cloud Run API v2 does not support labels with
run.googleapis.com
,cloud.googleapis.com
,serving.knative.dev
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.
-
(::Google::Protobuf::Map{::String => ::String}) — Unstructured key value map that can be used to organize and categorize
objects.
User-provided labels are shared with Google's billing system, so they can
be used to filter, or break down billing charges by team, component,
environment, state, etc. For more information, visit
https://cloud.google.com/resource-manager/docs/creating-managing-labels or
https://cloud.google.com/run/docs/configuring/labels.
Cloud Run API v2 does not support labels with
run.googleapis.com
,cloud.googleapis.com
,serving.knative.dev
, orautoscaling.knative.dev
namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.
#last_modifier
def last_modifier() -> ::String
- (::String) — Output only. Email address of the last authenticated modifier.
#latest_created_execution
def latest_created_execution() -> ::Google::Cloud::Run::V2::ExecutionReference
- (::Google::Cloud::Run::V2::ExecutionReference) — Output only. Name of the last created execution.
#launch_stage
def launch_stage() -> ::Google::Api::LaunchStage
-
(::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports
ALPHA
,BETA
, andGA
. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
#launch_stage=
def launch_stage=(value) -> ::Google::Api::LaunchStage
-
value (::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports
ALPHA
,BETA
, andGA
. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
-
(::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports
ALPHA
,BETA
, andGA
. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
#name
def name() -> ::String
-
(::String) — The fully qualified name of this Job.
Format: projects/{project}/locations/{location}/jobs/{job}
#name=
def name=(value) -> ::String
-
value (::String) — The fully qualified name of this Job.
Format: projects/{project}/locations/{location}/jobs/{job}
-
(::String) — The fully qualified name of this Job.
Format: projects/{project}/locations/{location}/jobs/{job}
#observed_generation
def observed_generation() -> ::Integer
-
(::Integer) — Output only. The generation of this Job. See comments in
reconciling
for additional information on reconciliation process in Cloud Run.
#reconciling
def reconciling() -> ::Boolean
-
(::Boolean) — Output only. Returns true if the Job is currently being acted upon by the
system to bring it into the desired state.
When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process,
observed_generation
andlatest_succeeded_execution
, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found interminal_condition.state
.If reconciliation succeeded, the following fields will match:
observed_generation
andgeneration
,latest_succeeded_execution
andlatest_created_execution
.If reconciliation failed,
observed_generation
andlatest_succeeded_execution
will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found interminal_condition
andconditions
.
#satisfies_pzs
def satisfies_pzs() -> ::Boolean
- (::Boolean) — Output only. Reserved for future use.
#template
def template() -> ::Google::Cloud::Run::V2::ExecutionTemplate
- (::Google::Cloud::Run::V2::ExecutionTemplate) — Required. The template used to create executions for this Job.
#template=
def template=(value) -> ::Google::Cloud::Run::V2::ExecutionTemplate
- value (::Google::Cloud::Run::V2::ExecutionTemplate) — Required. The template used to create executions for this Job.
- (::Google::Cloud::Run::V2::ExecutionTemplate) — Required. The template used to create executions for this Job.
#terminal_condition
def terminal_condition() -> ::Google::Cloud::Run::V2::Condition
- (::Google::Cloud::Run::V2::Condition) — Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
#uid
def uid() -> ::String
- (::String) — Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The last-modified time.