Enum JobState 

#[non_exhaustive]
pub enum JobState {
    Unspecified,
    Queued,
    Pending,
    Running,
    Succeeded,
    Failed,
    Cancelling,
    Cancelled,
    Paused,
    Expired,
    Updating,
    PartiallySucceeded,
    UnknownValue(UnknownValue),
}

Available on crate features gen-ai-tuning-service or job-service or notebook-service or schedule-service only.

Describes the state of a job.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

The job state is unspecified.

Queued

The job has been just created or resumed and processing has not yet begun.

Pending

The service is preparing to run the job.

Running

The job is in progress.

Succeeded

The job completed successfully.

Failed

The job failed.

Cancelling

The job is being cancelled. From this state the job may only go to either JOB_STATE_SUCCEEDED, JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Cancelled

The job has been cancelled.

Paused

The job has been stopped, and can be resumed.

Expired

The job has expired.

Updating

The job is being updated. Only jobs in the RUNNING state can be updated. After updating, the job goes back to the RUNNING state.

PartiallySucceeded

The job is partially succeeded, some results may be missing due to errors.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using JobState::value or JobState::name.

Implementations

impl JobState

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for JobState

fn clone(&self) -> JobState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JobState

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

Formats the value using the given formatter.

impl Default for JobState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JobState

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JobState

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

Formats the value using the given formatter.

impl From<&str> for JobState

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for JobState

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for JobState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for JobState

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JobState