Class Job.Builder (1.35.0)

public static final class Job.Builder extends GeneratedMessageV3.Builder<Job.Builder> implements JobOrBuilder

Transcoding job resource.

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

Implements

JobOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Job.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Job.Builder
Overrides

build()

public Job build()
Returns
TypeDescription
Job

buildPartial()

public Job buildPartial()
Returns
TypeDescription
Job

clear()

public Job.Builder clear()
Returns
TypeDescription
Job.Builder
Overrides

clearBatchModePriority()

public Job.Builder clearBatchModePriority()

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
TypeDescription
Job.Builder

This builder for chaining.

clearConfig()

public Job.Builder clearConfig()

The configuration for this job.

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

Returns
TypeDescription
Job.Builder

clearCreateTime()

public Job.Builder clearCreateTime()

Output only. The time the job was created.

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

Returns
TypeDescription
Job.Builder

clearEndTime()

public Job.Builder clearEndTime()

Output only. The time the transcoding finished.

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

Returns
TypeDescription
Job.Builder

clearError()

public Job.Builder clearError()

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
Job.Builder

clearField(Descriptors.FieldDescriptor field)

public Job.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Job.Builder
Overrides

clearInputUri()

public Job.Builder clearInputUri()

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
Job.Builder

This builder for chaining.

clearJobConfig()

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

clearLabels()

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

clearMode()

public Job.Builder clearMode()

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

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

Returns
TypeDescription
Job.Builder

This builder for chaining.

clearName()

public Job.Builder clearName()

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

string name = 1;

Returns
TypeDescription
Job.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Job.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Job.Builder
Overrides

clearOptimization()

public Job.Builder clearOptimization()

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
TypeDescription
Job.Builder

This builder for chaining.

clearOutputUri()

public Job.Builder clearOutputUri()

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
Job.Builder

This builder for chaining.

clearStartTime()

public Job.Builder clearStartTime()

Output only. The time the transcoding started.

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

Returns
TypeDescription
Job.Builder

clearState()

public Job.Builder clearState()

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.Builder

This builder for chaining.

clearTemplateId()

public Job.Builder clearTemplateId()

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
TypeDescription
Job.Builder

This builder for chaining.

clearTtlAfterCompletionDays()

public Job.Builder clearTtlAfterCompletionDays()

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
Job.Builder

This builder for chaining.

clone()

public Job.Builder clone()
Returns
TypeDescription
Job.Builder
Overrides

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

getBatchModePriority()

public 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
TypeDescription
int

The batchModePriority.

getConfig()

public JobConfig getConfig()

The configuration for this job.

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

Returns
TypeDescription
JobConfig

The config.

getConfigBuilder()

public JobConfig.Builder getConfigBuilder()

The configuration for this job.

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

Returns
TypeDescription
JobConfig.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time the job was created.

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

Returns
TypeDescription
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. The time the transcoding finished.

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

Returns
TypeDescription
Builder

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.

getErrorBuilder()

public Status.Builder getErrorBuilder()

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.Builder

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() (deprecated)

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

getMode()

public 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
TypeDescription
Job.ProcessingMode

The mode.

getModeValue()

public int getModeValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for mode.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,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.

getOptimization()

public 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
TypeDescription
Job.OptimizationStrategy

The optimization.

getOptimizationValue()

public 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
TypeDescription
int

The enum numeric value on the wire for optimization.

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.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. The time the transcoding started.

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

Returns
TypeDescription
Builder

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

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

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.

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.