public final class Job extends GeneratedMessageV3 implements JobOrBuilder
Transcoding job resource.
Protobuf type google.cloud.video.transcoder.v1.Job
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BATCH_MODE_PRIORITY_FIELD_NUMBER
public static final int BATCH_MODE_PRIORITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INPUT_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MODE_FIELD_NUMBER
public static final int MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OPTIMIZATION_FIELD_NUMBER
public static final int OPTIMIZATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OUTPUT_URI_FIELD_NUMBER
public static final int OUTPUT_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TEMPLATE_ID_FIELD_NUMBER
public static final int TEMPLATE_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TTL_AFTER_COMPLETION_DAYS_FIELD_NUMBER
public static final int TTL_AFTER_COMPLETION_DAYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Job getDefaultInstance()
| Returns |
|---|
| Type | Description |
Job | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Job.Builder newBuilder()
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
| Parameter |
|---|
| Name | Description |
prototype | Job
|
public static Job parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Job | |
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Job | |
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Job | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Job | |
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Job | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Job | |
public static Job parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Job | |
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Job | |
public static Job parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Job | |
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Job | |
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Job | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Job | |
parser()
public static Parser<Job> parser()
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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 |
|---|
| Type | Description |
int | The batchModePriority.
|
getConfig()
public JobConfig getConfig()
The configuration for this job.
.google.cloud.video.transcoder.v1.JobConfig config = 5;
getConfigOrBuilder()
public JobConfigOrBuilder getConfigOrBuilder()
The configuration for this job.
.google.cloud.video.transcoder.v1.JobConfig config = 5;
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 |
|---|
| Type | Description |
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];
getDefaultInstanceForType()
public Job getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Job | |
getEndTime()
public Timestamp getEndTime()
Output only. The time the transcoding finished.
.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. The time the transcoding finished.
.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 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 | |
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 |
|---|
| Type | Description |
String | The inputUri.
|
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 |
|---|
| Type | Description |
ByteString | The bytes for inputUri.
|
getJobConfigCase()
public Job.JobConfigCase getJobConfigCase()
getLabels() (deprecated)
public Map<String,String> getLabels()
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 |
|---|
| Type | Description |
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;
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;
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 |
|---|
| Name | Description |
key | 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;
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 |
|---|
| Type | Description |
int | The enum numeric value on the wire for mode.
|
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 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 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];
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for outputUri.
|
getParserForType()
public Parser<Job> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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];
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];
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
int | The ttlAfterCompletionDays.
|
hasConfig()
public 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 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 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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Job.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Job.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
