Struct JobState

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

Job state.

[JsonConverter(typeof(JobStateConverter))]
public readonly record struct JobState : IEquatable<JobState>

Implements

IEquatable<JobState>

Inherited Members

ValueType.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

AllValues

public static IReadOnlyList<JobState> AllValues { get; }

Property Value

IReadOnlyList<JobState>

JobStateCancelled

The job has been cancelled.

public static JobState JobStateCancelled { get; }

Property Value

JobState

JobStateCancelling

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.

public static JobState JobStateCancelling { get; }

Property Value

JobState

JobStateExpired

The job has expired.

public static JobState JobStateExpired { get; }

Property Value

JobState

JobStateFailed

The job failed.

public static JobState JobStateFailed { get; }

Property Value

JobState

JobStatePartiallySucceeded

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

public static JobState JobStatePartiallySucceeded { get; }

Property Value

JobState

JobStatePaused

The job has been stopped, and can be resumed.

public static JobState JobStatePaused { get; }

Property Value

JobState

JobStatePending

The service is preparing to run the job.

public static JobState JobStatePending { get; }

Property Value

JobState

JobStateQueued

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

public static JobState JobStateQueued { get; }

Property Value

JobState

JobStateRunning

The job is in progress.

public static JobState JobStateRunning { get; }

Property Value

JobState

JobStateSucceeded

The job completed successfully.

public static JobState JobStateSucceeded { get; }

Property Value

JobState

JobStateUnspecified

The job state is unspecified.

public static JobState JobStateUnspecified { get; }

Property Value

JobState

JobStateUpdating

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

public static JobState JobStateUpdating { get; }

Property Value

JobState

Value

public string Value { get; }

Property Value

string

Methods

Equals(JobState)

public bool Equals(JobState other)

Parameters

other JobState

Returns

bool

FromString(string)

public static JobState FromString(string value)

Parameters

value string

Returns

JobState

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

implicit operator JobState(string)

public static implicit operator JobState(string value)

Parameters

value string

Returns

JobState