Class JobStatus (0.49.0)

public final class JobStatus extends GeneratedMessageV3 implements JobStatusOrBuilder

Job status.

Protobuf type google.cloud.batch.v1alpha.JobStatus

Implements

JobStatusOrBuilder

Static Fields

RESOURCE_USAGE_FIELD_NUMBER

public static final int RESOURCE_USAGE_FIELD_NUMBER
Field Value
Type Description
int

RUN_DURATION_FIELD_NUMBER

public static final int RUN_DURATION_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_EVENTS_FIELD_NUMBER

public static final int STATUS_EVENTS_FIELD_NUMBER
Field Value
Type Description
int

TASK_GROUPS_FIELD_NUMBER

public static final int TASK_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static JobStatus getDefaultInstance()
Returns
Type Description
JobStatus

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static JobStatus.Builder newBuilder()
Returns
Type Description
JobStatus.Builder

newBuilder(JobStatus prototype)

public static JobStatus.Builder newBuilder(JobStatus prototype)
Parameter
Name Description
prototype JobStatus
Returns
Type Description
JobStatus.Builder

parseDelimitedFrom(InputStream input)

public static JobStatus parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JobStatus
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobStatus
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static JobStatus parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
JobStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JobStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JobStatus parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
JobStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JobStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JobStatus parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
JobStatus
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JobStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobStatus
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static JobStatus parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JobStatus
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobStatus
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static JobStatus parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
JobStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JobStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobStatus
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<JobStatus> parser()
Returns
Type Description
Parser<JobStatus>

Methods

containsTaskGroups(String key)

public boolean containsTaskGroups(String key)

Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

map<string, .google.cloud.batch.v1alpha.JobStatus.TaskGroupStatus> task_groups = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public JobStatus getDefaultInstanceForType()
Returns
Type Description
JobStatus

getParserForType()

public Parser<JobStatus> getParserForType()
Returns
Type Description
Parser<JobStatus>
Overrides

getResourceUsage()

public ResourceUsage getResourceUsage()

The resource usage of the job.

.google.cloud.batch.v1alpha.ResourceUsage resource_usage = 6;

Returns
Type Description
ResourceUsage

The resourceUsage.

getResourceUsageOrBuilder()

public ResourceUsageOrBuilder getResourceUsageOrBuilder()

The resource usage of the job.

.google.cloud.batch.v1alpha.ResourceUsage resource_usage = 6;

Returns
Type Description
ResourceUsageOrBuilder

getRunDuration()

public Duration getRunDuration()

The duration of time that the Job spent in status RUNNING.

.google.protobuf.Duration run_duration = 5;

Returns
Type Description
Duration

The runDuration.

getRunDurationOrBuilder()

public DurationOrBuilder getRunDurationOrBuilder()

The duration of time that the Job spent in status RUNNING.

.google.protobuf.Duration run_duration = 5;

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public JobStatus.State getState()

Job state

.google.cloud.batch.v1alpha.JobStatus.State state = 1;

Returns
Type Description
JobStatus.State

The state.

getStateValue()

public int getStateValue()

Job state

.google.cloud.batch.v1alpha.JobStatus.State state = 1;

Returns
Type Description
int

The enum numeric value on the wire for state.

getStatusEvents(int index)

public StatusEvent getStatusEvents(int index)

Job status events

repeated .google.cloud.batch.v1alpha.StatusEvent status_events = 2;

Parameter
Name Description
index int
Returns
Type Description
StatusEvent

getStatusEventsCount()

public int getStatusEventsCount()

Job status events

repeated .google.cloud.batch.v1alpha.StatusEvent status_events = 2;

Returns
Type Description
int

getStatusEventsList()

public List<StatusEvent> getStatusEventsList()

Job status events

repeated .google.cloud.batch.v1alpha.StatusEvent status_events = 2;

Returns
Type Description
List<StatusEvent>

getStatusEventsOrBuilder(int index)

public StatusEventOrBuilder getStatusEventsOrBuilder(int index)

Job status events

repeated .google.cloud.batch.v1alpha.StatusEvent status_events = 2;

Parameter
Name Description
index int
Returns
Type Description
StatusEventOrBuilder

getStatusEventsOrBuilderList()

public List<? extends StatusEventOrBuilder> getStatusEventsOrBuilderList()

Job status events

repeated .google.cloud.batch.v1alpha.StatusEvent status_events = 2;

Returns
Type Description
List<? extends com.google.cloud.batch.v1alpha.StatusEventOrBuilder>

getTaskGroups() (deprecated)

public Map<String,JobStatus.TaskGroupStatus> getTaskGroups()

Use #getTaskGroupsMap() instead.

Returns
Type Description
Map<String,TaskGroupStatus>

getTaskGroupsCount()

public int getTaskGroupsCount()

Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

map<string, .google.cloud.batch.v1alpha.JobStatus.TaskGroupStatus> task_groups = 4;

Returns
Type Description
int

getTaskGroupsMap()

public Map<String,JobStatus.TaskGroupStatus> getTaskGroupsMap()

Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

map<string, .google.cloud.batch.v1alpha.JobStatus.TaskGroupStatus> task_groups = 4;

Returns
Type Description
Map<String,TaskGroupStatus>

getTaskGroupsOrDefault(String key, JobStatus.TaskGroupStatus defaultValue)

public JobStatus.TaskGroupStatus getTaskGroupsOrDefault(String key, JobStatus.TaskGroupStatus defaultValue)

Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

map<string, .google.cloud.batch.v1alpha.JobStatus.TaskGroupStatus> task_groups = 4;

Parameters
Name Description
key String
defaultValue JobStatus.TaskGroupStatus
Returns
Type Description
JobStatus.TaskGroupStatus

getTaskGroupsOrThrow(String key)

public JobStatus.TaskGroupStatus getTaskGroupsOrThrow(String key)

Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

map<string, .google.cloud.batch.v1alpha.JobStatus.TaskGroupStatus> task_groups = 4;

Parameter
Name Description
key String
Returns
Type Description
JobStatus.TaskGroupStatus

hasResourceUsage()

public boolean hasResourceUsage()

The resource usage of the job.

.google.cloud.batch.v1alpha.ResourceUsage resource_usage = 6;

Returns
Type Description
boolean

Whether the resourceUsage field is set.

hasRunDuration()

public boolean hasRunDuration()

The duration of time that the Job spent in status RUNNING.

.google.protobuf.Duration run_duration = 5;

Returns
Type Description
boolean

Whether the runDuration field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public JobStatus.Builder newBuilderForType()
Returns
Type Description
JobStatus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JobStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
JobStatus.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public JobStatus.Builder toBuilder()
Returns
Type Description
JobStatus.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException