Interface JobOrBuilder (1.53.0)

Version 1.53.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.5
• 1.0.4
• 0.4.3

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
Name	Description
key	String

Returns
Type	Description
boolean

getBatchModePriority()

public abstract int getBatchModePriority()

The processing priority of a batch job. This field can only be set for batch mode jobs. The default value is 0. This value cannot be negative. Higher values correspond to higher priorities for the job.

int32 batch_mode_priority = 21;

Returns
Type	Description
int	The batchModePriority.

getConfig()

public abstract JobConfig getConfig()

The configuration for this job.

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

Returns
Type	Description
JobConfig	The config.

getConfigOrBuilder()

public abstract JobConfigOrBuilder getConfigOrBuilder()

The configuration for this job.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for inputUri.

getJobConfigCase()

public abstract Job.JobConfigCase getJobConfigCase()

Returns
Type	Description
Job.JobConfigCase

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
key	String
defaultValue	String

Returns
Type	Description
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
Name	Description
key	String

Returns
Type	Description
String

getMode()

public abstract Job.ProcessingMode getMode()

The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE.

.google.cloud.video.transcoder.v1.Job.ProcessingMode mode = 20;

Returns
Type	Description
Job.ProcessingMode	The mode.

getModeValue()

public abstract int getModeValue()

The processing mode of the job. The default is PROCESSING_MODE_INTERACTIVE.

.google.cloud.video.transcoder.v1.Job.ProcessingMode mode = 20;

Returns
Type	Description
int	The enum numeric value on the wire for mode.

getName()

public abstract String getName()

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

string name = 1;

Returns
Type	Description
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
Type	Description
ByteString	The bytes for name.

getOptimization()

public abstract Job.OptimizationStrategy getOptimization()

Optional. The optimization strategy of the job. The default is AUTODETECT.

.google.cloud.video.transcoder.v1.Job.OptimizationStrategy optimization = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Job.OptimizationStrategy	The optimization.

getOptimizationValue()

public abstract int getOptimizationValue()

Optional. The optimization strategy of the job. The default is AUTODETECT.

.google.cloud.video.transcoder.v1.Job.OptimizationStrategy optimization = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for optimization.

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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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, which is the only supported preset.

User defined JobTemplate: {job_template_id}

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

Returns
Type	Description
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, which is the only supported preset.

User defined JobTemplate: {job_template_id}

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

Returns
Type	Description
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
Type	Description
int	The ttlAfterCompletionDays.

hasConfig()

public abstract boolean hasConfig()

The configuration for this job.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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, which is the only supported preset.

User defined JobTemplate: {job_template_id}

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

Returns
Type	Description
boolean	Whether the templateId field is set.