Class Job (1.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public final class Job extends GeneratedMessageV3 implements JobOrBuilder

Transcoding job resource.

Protobuf type google.cloud.video.transcoder.v1.Job

Implements

JobOrBuilder

Static Fields

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_URI_FIELD_NUMBER

public static final int INPUT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_URI_FIELD_NUMBER

public static final int OUTPUT_URI_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TEMPLATE_ID_FIELD_NUMBER

public static final int TEMPLATE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

TTL_AFTER_COMPLETION_DAYS_FIELD_NUMBER

public static final int TTL_AFTER_COMPLETION_DAYS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Job getDefaultInstance()
Returns
TypeDescription
Job

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Job.Builder newBuilder()
Returns
TypeDescription
Job.Builder

newBuilder(Job prototype)

public static Job.Builder newBuilder(Job prototype)
Parameter
NameDescription
prototypeJob
Returns
TypeDescription
Job.Builder

parseDelimitedFrom(InputStream input)

public static Job parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Job parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Job parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Job parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Job parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Job parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Job
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Job> parser()
Returns
TypeDescription
Parser<Job>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

The labels associated with this job. You can use these to organize and group your jobs.

map<string, string> labels = 16;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConfig()

public JobConfig getConfig()

The configuration for this job.

.google.cloud.video.transcoder.v1.JobConfig config = 5;

Returns
TypeDescription
JobConfig

The config.

getConfigOrBuilder()

public JobConfigOrBuilder getConfigOrBuilder()

The configuration for this job.

.google.cloud.video.transcoder.v1.JobConfig config = 5;

Returns
TypeDescription
JobConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the job was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the job was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Job getDefaultInstanceForType()
Returns
TypeDescription
Job

getEndTime()

public Timestamp getEndTime()

Output only. The time the transcoding finished.

.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time the transcoding finished.

.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getError()

public Status getError()

Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

.google.rpc.Status error = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

.google.rpc.Status error = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getInputUri()

public String getInputUri()

Input only. Specify the input_uri to populate empty uri fields in each element of Job.config.inputs or JobTemplate.config.inputs when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, gs://bucket/inputs/file.mp4). See Supported input and output formats.

string input_uri = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
String

The inputUri.

getInputUriBytes()

public ByteString getInputUriBytes()

Input only. Specify the input_uri to populate empty uri fields in each element of Job.config.inputs or JobTemplate.config.inputs when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, gs://bucket/inputs/file.mp4). See Supported input and output formats.

string input_uri = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for inputUri.

getJobConfigCase()

public Job.JobConfigCase getJobConfigCase()
Returns
TypeDescription
Job.JobConfigCase

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels associated with this job. You can use these to organize and group your jobs.

map<string, string> labels = 16;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels associated with this job. You can use these to organize and group your jobs.

map<string, string> labels = 16;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels associated with this job. You can use these to organize and group your jobs.

map<string, string> labels = 16;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels associated with this job. You can use these to organize and group your jobs.

map<string, string> labels = 16;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

The resource name of the job. Format: projects/{project_number}/locations/{location}/jobs/{job}

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the job. Format: projects/{project_number}/locations/{location}/jobs/{job}

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOutputUri()

public String getOutputUri()

Input only. Specify the output_uri to populate an empty Job.config.output.uri or JobTemplate.config.output.uri when using template. URI for the output file(s). For example, gs://my-bucket/outputs/. See Supported input and output formats.

string output_uri = 3 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
String

The outputUri.

getOutputUriBytes()

public ByteString getOutputUriBytes()

Input only. Specify the output_uri to populate an empty Job.config.output.uri or JobTemplate.config.output.uri when using template. URI for the output file(s). For example, gs://my-bucket/outputs/. See Supported input and output formats.

string output_uri = 3 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for outputUri.

getParserForType()

public Parser<Job> getParserForType()
Returns
TypeDescription
Parser<Job>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. The time the transcoding started.

.google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time the transcoding started.

.google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getState()

public Job.ProcessingState getState()

Output only. The current state of the job.

.google.cloud.video.transcoder.v1.Job.ProcessingState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Job.ProcessingState

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the job.

.google.cloud.video.transcoder.v1.Job.ProcessingState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTemplateId()

public String getTemplateId()

Input only. Specify the template_id to use for populating Job.config. The default is preset/web-hd. Preset Transcoder templates:

  • preset/{preset_id}
  • User defined JobTemplate: {job_template_id}

string template_id = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
String

The templateId.

getTemplateIdBytes()

public ByteString getTemplateIdBytes()

Input only. Specify the template_id to use for populating Job.config. The default is preset/web-hd. Preset Transcoder templates:

  • preset/{preset_id}
  • User defined JobTemplate: {job_template_id}

string template_id = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for templateId.

getTtlAfterCompletionDays()

public int getTtlAfterCompletionDays()

Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.

int32 ttl_after_completion_days = 15;

Returns
TypeDescription
int

The ttlAfterCompletionDays.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasConfig()

public boolean hasConfig()

The configuration for this job.

.google.cloud.video.transcoder.v1.JobConfig config = 5;

Returns
TypeDescription
boolean

Whether the config field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the job was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The time the transcoding finished.

.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasError()

public boolean hasError()

Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

.google.rpc.Status error = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the error field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The time the transcoding started.

.google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the startTime field is set.

hasTemplateId()

public boolean hasTemplateId()

Input only. Specify the template_id to use for populating Job.config. The default is preset/web-hd. Preset Transcoder templates:

  • preset/{preset_id}
  • User defined JobTemplate: {job_template_id}

string template_id = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
boolean

Whether the templateId field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Job.Builder newBuilderForType()
Returns
TypeDescription
Job.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Job.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Job.Builder toBuilder()
Returns
TypeDescription
Job.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException