Interface JobOrBuilder (1.2.1)

public interface JobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getConfig()

public abstract JobConfig getConfig()

The configuration for this job.

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

Returns
TypeDescription
JobConfig

The config.

getConfigOrBuilder()

public abstract JobConfigOrBuilder getConfigOrBuilder()

The configuration for this job.

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

Returns
TypeDescription
JobConfigOrBuilder

getCreateTime()

public abstract 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 abstract 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

getEndTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Job.JobConfigCase getJobConfigCase()
Returns
TypeDescription
Job.JobConfigCase

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getStartTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

hasConfig()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.