Job

Struct Job 

Source
#[non_exhaustive]
pub struct Job {
Show 25 fields pub name: String, pub uid: String, pub generation: i64, pub labels: HashMap<String, String>, pub annotations: HashMap<String, String>, pub create_time: Option<Timestamp>, pub update_time: Option<Timestamp>, pub delete_time: Option<Timestamp>, pub expire_time: Option<Timestamp>, pub creator: String, pub last_modifier: String, pub client: String, pub client_version: String, pub launch_stage: LaunchStage, pub binary_authorization: Option<BinaryAuthorization>, pub template: Option<ExecutionTemplate>, pub observed_generation: i64, pub terminal_condition: Option<Condition>, pub conditions: Vec<Condition>, pub execution_count: i32, pub latest_created_execution: Option<ExecutionReference>, pub reconciling: bool, pub satisfies_pzs: bool, pub etag: String, pub create_execution: Option<CreateExecution>, /* private fields */
}
Expand description

Job represents the configuration of a single job, which references a container image that is run to completion.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

The fully qualified name of this Job.

Format: projects/{project}/locations/{location}/jobs/{job}

§uid: 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.

§generation: i64

Output only. A number that monotonically increases every time the user modifies the desired state.

§labels: HashMap<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.

§annotations: HashMap<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.

§create_time: Option<Timestamp>

Output only. The creation time.

§update_time: Option<Timestamp>

Output only. The last-modified time.

§delete_time: Option<Timestamp>

Output only. The deletion time. It is only populated as a response to a Delete request.

§expire_time: Option<Timestamp>

Output only. For a deleted resource, the time after which it will be permamently deleted.

§creator: String

Output only. Email address of the authenticated creator.

§last_modifier: String

Output only. Email address of the last authenticated modifier.

§client: String

Arbitrary identifier for the API client.

§client_version: String

Arbitrary version identifier for the API client.

§launch_stage: LaunchStage

The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. 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.

§binary_authorization: Option<BinaryAuthorization>

Settings for the Binary Authorization feature.

§template: Option<ExecutionTemplate>

Required. The template used to create executions for this Job.

§observed_generation: i64

Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.

§terminal_condition: Option<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.

§conditions: Vec<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.

§execution_count: i32

Output only. Number of executions created for this job.

§latest_created_execution: Option<ExecutionReference>

Output only. Name of the last created execution.

§reconciling: bool

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 and latest_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 in terminal_condition.state.

If reconciliation succeeded, the following fields will match: observed_generation and generation, latest_succeeded_execution and latest_created_execution.

If reconciliation failed, observed_generation and latest_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 in terminal_condition and conditions.

§satisfies_pzs: bool

Output only. Reserved for future use.

§etag: String

Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

§create_execution: Option<CreateExecution>

Implementations§

Source§

impl Job

Source

pub fn new() -> Self

Source

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

§Example
let x = Job::new().set_name("example");
Source

pub fn set_uid<T: Into<String>>(self, v: T) -> Self

Sets the value of uid.

§Example
let x = Job::new().set_uid("example");
Source

pub fn set_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of generation.

§Example
let x = Job::new().set_generation(42);
Source

pub fn set_labels<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

§Example
let x = Job::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);
Source

pub fn set_annotations<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of annotations.

§Example
let x = Job::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);
Source

pub fn set_create_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of create_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_create_time(Timestamp::default()/* use setters */);
Source

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self
where T: Into<Timestamp>,

Sets or clears the value of create_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Job::new().set_or_clear_create_time(None::<Timestamp>);
Source

pub fn set_update_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of update_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_update_time(Timestamp::default()/* use setters */);
Source

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self
where T: Into<Timestamp>,

Sets or clears the value of update_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Job::new().set_or_clear_update_time(None::<Timestamp>);
Source

pub fn set_delete_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of delete_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_delete_time(Timestamp::default()/* use setters */);
Source

pub fn set_or_clear_delete_time<T>(self, v: Option<T>) -> Self
where T: Into<Timestamp>,

Sets or clears the value of delete_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_or_clear_delete_time(Some(Timestamp::default()/* use setters */));
let x = Job::new().set_or_clear_delete_time(None::<Timestamp>);
Source

pub fn set_expire_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of expire_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_expire_time(Timestamp::default()/* use setters */);
Source

pub fn set_or_clear_expire_time<T>(self, v: Option<T>) -> Self
where T: Into<Timestamp>,

Sets or clears the value of expire_time.

§Example
use wkt::Timestamp;
let x = Job::new().set_or_clear_expire_time(Some(Timestamp::default()/* use setters */));
let x = Job::new().set_or_clear_expire_time(None::<Timestamp>);
Source

pub fn set_creator<T: Into<String>>(self, v: T) -> Self

Sets the value of creator.

§Example
let x = Job::new().set_creator("example");
Source

pub fn set_last_modifier<T: Into<String>>(self, v: T) -> Self

Sets the value of last_modifier.

§Example
let x = Job::new().set_last_modifier("example");
Source

pub fn set_client<T: Into<String>>(self, v: T) -> Self

Sets the value of client.

§Example
let x = Job::new().set_client("example");
Source

pub fn set_client_version<T: Into<String>>(self, v: T) -> Self

Sets the value of client_version.

§Example
let x = Job::new().set_client_version("example");
Source

pub fn set_launch_stage<T: Into<LaunchStage>>(self, v: T) -> Self

Sets the value of launch_stage.

§Example
use api::model::LaunchStage;
let x0 = Job::new().set_launch_stage(LaunchStage::Unimplemented);
let x1 = Job::new().set_launch_stage(LaunchStage::Prelaunch);
let x2 = Job::new().set_launch_stage(LaunchStage::EarlyAccess);
Source

pub fn set_binary_authorization<T>(self, v: T) -> Self

Sets the value of binary_authorization.

§Example
use google_cloud_run_v2::model::BinaryAuthorization;
let x = Job::new().set_binary_authorization(BinaryAuthorization::default()/* use setters */);
Source

pub fn set_or_clear_binary_authorization<T>(self, v: Option<T>) -> Self

Sets or clears the value of binary_authorization.

§Example
use google_cloud_run_v2::model::BinaryAuthorization;
let x = Job::new().set_or_clear_binary_authorization(Some(BinaryAuthorization::default()/* use setters */));
let x = Job::new().set_or_clear_binary_authorization(None::<BinaryAuthorization>);
Source

pub fn set_template<T>(self, v: T) -> Self

Sets the value of template.

§Example
use google_cloud_run_v2::model::ExecutionTemplate;
let x = Job::new().set_template(ExecutionTemplate::default()/* use setters */);
Source

pub fn set_or_clear_template<T>(self, v: Option<T>) -> Self

Sets or clears the value of template.

§Example
use google_cloud_run_v2::model::ExecutionTemplate;
let x = Job::new().set_or_clear_template(Some(ExecutionTemplate::default()/* use setters */));
let x = Job::new().set_or_clear_template(None::<ExecutionTemplate>);
Source

pub fn set_observed_generation<T: Into<i64>>(self, v: T) -> Self

Sets the value of observed_generation.

§Example
let x = Job::new().set_observed_generation(42);
Source

pub fn set_terminal_condition<T>(self, v: T) -> Self
where T: Into<Condition>,

Sets the value of terminal_condition.

§Example
use google_cloud_run_v2::model::Condition;
let x = Job::new().set_terminal_condition(Condition::default()/* use setters */);
Source

pub fn set_or_clear_terminal_condition<T>(self, v: Option<T>) -> Self
where T: Into<Condition>,

Sets or clears the value of terminal_condition.

§Example
use google_cloud_run_v2::model::Condition;
let x = Job::new().set_or_clear_terminal_condition(Some(Condition::default()/* use setters */));
let x = Job::new().set_or_clear_terminal_condition(None::<Condition>);
Source

pub fn set_conditions<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<Condition>,

Sets the value of conditions.

§Example
use google_cloud_run_v2::model::Condition;
let x = Job::new()
    .set_conditions([
        Condition::default()/* use setters */,
        Condition::default()/* use (different) setters */,
    ]);
Source

pub fn set_execution_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of execution_count.

§Example
let x = Job::new().set_execution_count(42);
Source

pub fn set_latest_created_execution<T>(self, v: T) -> Self

Sets the value of latest_created_execution.

§Example
use google_cloud_run_v2::model::ExecutionReference;
let x = Job::new().set_latest_created_execution(ExecutionReference::default()/* use setters */);
Source

pub fn set_or_clear_latest_created_execution<T>(self, v: Option<T>) -> Self

Sets or clears the value of latest_created_execution.

§Example
use google_cloud_run_v2::model::ExecutionReference;
let x = Job::new().set_or_clear_latest_created_execution(Some(ExecutionReference::default()/* use setters */));
let x = Job::new().set_or_clear_latest_created_execution(None::<ExecutionReference>);
Source

pub fn set_reconciling<T: Into<bool>>(self, v: T) -> Self

Sets the value of reconciling.

§Example
let x = Job::new().set_reconciling(true);
Source

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

§Example
let x = Job::new().set_satisfies_pzs(true);
Source

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

§Example
let x = Job::new().set_etag("example");
Source

pub fn set_create_execution<T: Into<Option<CreateExecution>>>( self, v: T, ) -> Self

Sets the value of create_execution.

Note that all the setters affecting create_execution are mutually exclusive.

§Example
use google_cloud_run_v2::model::job::CreateExecution;
let x = Job::new().set_create_execution(Some(CreateExecution::StartExecutionToken("example".to_string())));
Source

pub fn start_execution_token(&self) -> Option<&String>

The value of create_execution if it holds a StartExecutionToken, None if the field is not set or holds a different branch.

Source

pub fn set_start_execution_token<T: Into<String>>(self, v: T) -> Self

Sets the value of create_execution to hold a StartExecutionToken.

Note that all the setters affecting create_execution are mutually exclusive.

§Example
let x = Job::new().set_start_execution_token("example");
assert!(x.start_execution_token().is_some());
assert!(x.run_execution_token().is_none());
Source

pub fn run_execution_token(&self) -> Option<&String>

The value of create_execution if it holds a RunExecutionToken, None if the field is not set or holds a different branch.

Source

pub fn set_run_execution_token<T: Into<String>>(self, v: T) -> Self

Sets the value of create_execution to hold a RunExecutionToken.

Note that all the setters affecting create_execution are mutually exclusive.

§Example
let x = Job::new().set_run_execution_token("example");
assert!(x.run_execution_token().is_some());
assert!(x.start_execution_token().is_none());

Trait Implementations§

Source§

impl Clone for Job

Source§

fn clone(&self) -> Job

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Job

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Job

Source§

fn default() -> Job

Returns the “default value” for a type. Read more
Source§

impl Message for Job

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for Job

Source§

fn eq(&self, other: &Job) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Job

Auto Trait Implementations§

§

impl Freeze for Job

§

impl RefUnwindSafe for Job

§

impl Send for Job

§

impl Sync for Job

§

impl Unpin for Job

§

impl UnwindSafe for Job

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,