Package com.google.cloud.video.transcoder.v1

Class Job

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.transcoder.v1.Job
All Implemented Interfaces:
JobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Job extends com.google.protobuf.GeneratedMessage implements JobOrBuilder
 Transcoding job resource.
Protobuf type google.cloud.video.transcoder.v1.Job
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • INPUT_URI_FIELD_NUMBER

      public static final int INPUT_URI_FIELD_NUMBER
      See Also:

    • OUTPUT_URI_FIELD_NUMBER

      public static final int OUTPUT_URI_FIELD_NUMBER
      See Also:

    • TEMPLATE_ID_FIELD_NUMBER

      public static final int TEMPLATE_ID_FIELD_NUMBER
      See Also:

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • TTL_AFTER_COMPLETION_DAYS_FIELD_NUMBER

      public static final int TTL_AFTER_COMPLETION_DAYS_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • MODE_FIELD_NUMBER

      public static final int MODE_FIELD_NUMBER
      See Also:

    • BATCH_MODE_PRIORITY_FIELD_NUMBER

      public static final int BATCH_MODE_PRIORITY_FIELD_NUMBER
      See Also:

    • OPTIMIZATION_FIELD_NUMBER

      public static final int OPTIMIZATION_FIELD_NUMBER
      See Also:

    • FILL_CONTENT_GAPS_FIELD_NUMBER

      public static final int FILL_CONTENT_GAPS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getJobConfigCase

      public Job.JobConfigCase getJobConfigCase()
      Specified by:
      getJobConfigCase in interface JobOrBuilder

    • getName

      public String getName()
       The resource name of the job.
 Format: `projects/{project_number}/locations/{location}/jobs/{job}`
      string name = 1;
      Specified by:
      getName in interface JobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the job.
 Format: `projects/{project_number}/locations/{location}/jobs/{job}`
      string name = 1;
      Specified by:
      getNameBytes in interface JobOrBuilder
      Returns:
      The bytes for name.

    • 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](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
      string input_uri = 2 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getInputUri in interface JobOrBuilder
      Returns:
      The inputUri.

    • getInputUriBytes

      public 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];
      Specified by:
      getInputUriBytes in interface JobOrBuilder
      Returns:
      The bytes for inputUri.

    • 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](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).
      string output_uri = 3 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getOutputUri in interface JobOrBuilder
      Returns:
      The outputUri.

    • getOutputUriBytes

      public 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];
      Specified by:
      getOutputUriBytes in interface JobOrBuilder
      Returns:
      The bytes for outputUri.

    • 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];
      Specified by:
      hasTemplateId in interface JobOrBuilder
      Returns:
      Whether the templateId field is set.

    • 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];
      Specified by:
      getTemplateId in interface JobOrBuilder
      Returns:
      The templateId.

    • getTemplateIdBytes

      public com.google.protobuf.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];
      Specified by:
      getTemplateIdBytes in interface JobOrBuilder
      Returns:
      The bytes for templateId.

    • hasConfig

      public boolean hasConfig()
       The configuration for this job.
      .google.cloud.video.transcoder.v1.JobConfig config = 5;
      Specified by:
      hasConfig in interface JobOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      public JobConfig getConfig()
       The configuration for this job.
      .google.cloud.video.transcoder.v1.JobConfig config = 5;
      Specified by:
      getConfig in interface JobOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      public JobConfigOrBuilder getConfigOrBuilder()
       The configuration for this job.
      .google.cloud.video.transcoder.v1.JobConfig config = 5;
      Specified by:
      getConfigOrBuilder in interface JobOrBuilder

    • 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];
      Specified by:
      getStateValue in interface JobOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface JobOrBuilder
      Returns:
      The state.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time the job was created.
      .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface JobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface JobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface JobOrBuilder

    • hasStartTime

      public boolean hasStartTime()
       Output only. The time the transcoding started.
      .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasStartTime in interface JobOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Output only. The time the transcoding started.
      .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTime in interface JobOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Output only. The time the transcoding started.
      .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTimeOrBuilder in interface JobOrBuilder

    • hasEndTime

      public boolean hasEndTime()
       Output only. The time the transcoding finished.
      .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEndTime in interface JobOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       Output only. The time the transcoding finished.
      .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTime in interface JobOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       Output only. The time the transcoding finished.
      .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTimeOrBuilder in interface JobOrBuilder

    • 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;
      Specified by:
      getTtlAfterCompletionDays in interface JobOrBuilder
      Returns:
      The ttlAfterCompletionDays.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: JobOrBuilder
       The labels associated with this job. You can use these to organize and
 group your jobs.
      map<string, string> labels = 16;
      Specified by:
      getLabelsCount in interface JobOrBuilder

    • containsLabels

      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;
      Specified by:
      containsLabels in interface JobOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface JobOrBuilder

    • 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;
      Specified by:
      getLabelsMap in interface JobOrBuilder

    • getLabelsOrDefault

      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;
      Specified by:
      getLabelsOrDefault in interface JobOrBuilder

    • getLabelsOrThrow

      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;
      Specified by:
      getLabelsOrThrow in interface JobOrBuilder

    • hasError

      public boolean hasError()
       Output only. An error object that describes the reason for the failure.
 This property is always present when
 [ProcessingState][google.cloud.video.transcoder.v1.Job.ProcessingState] is
 `FAILED`.
      .google.rpc.Status error = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasError in interface JobOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status getError()
       Output only. An error object that describes the reason for the failure.
 This property is always present when
 [ProcessingState][google.cloud.video.transcoder.v1.Job.ProcessingState] is
 `FAILED`.
      .google.rpc.Status error = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getError in interface JobOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public StatusOrBuilder getErrorOrBuilder()
       Output only. An error object that describes the reason for the failure.
 This property is always present when
 [ProcessingState][google.cloud.video.transcoder.v1.Job.ProcessingState] is
 `FAILED`.
      .google.rpc.Status error = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getErrorOrBuilder in interface JobOrBuilder

    • 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;
      Specified by:
      getModeValue in interface JobOrBuilder
      Returns:
      The enum numeric value on the wire for mode.

    • 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;
      Specified by:
      getMode in interface JobOrBuilder
      Returns:
      The mode.

    • 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;
      Specified by:
      getBatchModePriority in interface JobOrBuilder
      Returns:
      The batchModePriority.

    • 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];
      Specified by:
      getOptimizationValue in interface JobOrBuilder
      Returns:
      The enum numeric value on the wire for optimization.

    • 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];
      Specified by:
      getOptimization in interface JobOrBuilder
      Returns:
      The optimization.

    • getFillContentGaps

      public boolean getFillContentGaps()
       Optional. Insert silence and duplicate frames when timestamp gaps are
 detected in a given stream.
      bool fill_content_gaps = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFillContentGaps in interface JobOrBuilder
      Returns:
      The fillContentGaps.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Job parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Job parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Job parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Job parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Job parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Job parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Job.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Job.Builder newBuilder()

    • newBuilder

      public static Job.Builder newBuilder(Job prototype)

    • toBuilder

      public Job.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Job.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Job getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Job> parser()

    • getParserForType

      public com.google.protobuf.Parser<Job> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Job getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder