com.google.cloud.video.transcoder.v1

Interface JobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Job, Job.Builder

public interface JobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels associated with this job.
JobConfig	getConfig() The configuration for this job.
JobConfigOrBuilder	getConfigOrBuilder() The configuration for this job.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
com.google.rpc.Status	getError() Output only.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Output only.
String	getInputUri() Input only.
com.google.protobuf.ByteString	getInputUriBytes() Input only.
Job.JobConfigCase	getJobConfigCase()
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels associated with this job.
Map<String,String>	getLabelsMap() The labels associated with this job.
String	getLabelsOrDefault(String key, String defaultValue) The labels associated with this job.
String	getLabelsOrThrow(String key) The labels associated with this job.
String	getName() The resource name of the job.
com.google.protobuf.ByteString	getNameBytes() The resource name of the job.
String	getOutputUri() Input only.
com.google.protobuf.ByteString	getOutputUriBytes() Input only.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
Job.ProcessingState	getState() Output only.
int	getStateValue() Output only.
String	getTemplateId() Input only.
com.google.protobuf.ByteString	getTemplateIdBytes() Input only.
int	getTtlAfterCompletionDays() Job time to live value in days, which will be effective after job completion.
boolean	hasConfig() The configuration for this job.
boolean	hasCreateTime() Output only.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
boolean	hasStartTime() Output only.
boolean	hasTemplateId() Input only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Returns:

The bytes for name.

getInputUri

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](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
 

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

Returns:

The inputUri.

getInputUriBytes

com.google.protobuf.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](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
 

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

Returns:

The bytes for inputUri.

getOutputUri

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](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
 

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

Returns:

The outputUri.

getOutputUriBytes

com.google.protobuf.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](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
 

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

Returns:

The bytes for outputUri.

hasTemplateId

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:

Whether the templateId field is set.

getTemplateId

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:

The templateId.

getTemplateIdBytes

com.google.protobuf.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:

The bytes for templateId.

hasConfig

boolean hasConfig()

 The configuration for this job.
 

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

Returns:

Whether the config field is set.

getConfig

JobConfig getConfig()

 The configuration for this job.
 

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

Returns:

The config.

getConfigOrBuilder

JobConfigOrBuilder getConfigOrBuilder()

 The configuration for this job.
 

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

getStateValue

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:

The enum numeric value on the wire for state.

getState

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:

The state.

hasCreateTime

boolean hasCreateTime()

 Output only. The time the job was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. The time the job was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time the job was created.
 

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

hasStartTime

boolean hasStartTime()

 Output only. The time the transcoding started.
 

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

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Output only. The time the transcoding started.
 

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

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. The time the transcoding started.
 

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

hasEndTime

boolean hasEndTime()

 Output only. The time the transcoding finished.
 

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

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Output only. The time the transcoding finished.
 

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

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Output only. The time the transcoding finished.
 

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

getTtlAfterCompletionDays

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:

The ttlAfterCompletionDays.

getLabelsCount

int getLabelsCount()

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

map<string, string> labels = 16;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

hasError

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:

Whether the error field is set.

getError

com.google.rpc.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:

The error.

getErrorOrBuilder

com.google.rpc.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];

getJobConfigCase

Job.JobConfigCase getJobConfigCase()