JobOrBuilder.java

/*
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/video/transcoder/v1beta1/resources.proto

package com.google.cloud.video.transcoder.v1beta1;

public interface JobOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.video.transcoder.v1beta1.Job)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The resource name of the job.
   * Format: `projects/{project}/locations/{location}/jobs/{job}`
   * </pre>
   *
   * <code>string name = 1;</code>
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * <pre>
   * The resource name of the job.
   * Format: `projects/{project}/locations/{location}/jobs/{job}`
   * </pre>
   *
   * <code>string name = 1;</code>
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * <pre>
   * 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. It must be stored in Cloud Storage. For example,
   * `gs://bucket/inputs/file.mp4`.
   * </pre>
   *
   * <code>string input_uri = 2 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return The inputUri.
   */
  java.lang.String getInputUri();
  /**
   *
   *
   * <pre>
   * 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. It must be stored in Cloud Storage. For example,
   * `gs://bucket/inputs/file.mp4`.
   * </pre>
   *
   * <code>string input_uri = 2 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return The bytes for inputUri.
   */
  com.google.protobuf.ByteString getInputUriBytes();

  /**
   *
   *
   * <pre>
   * 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/`.
   * </pre>
   *
   * <code>string output_uri = 3 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return The outputUri.
   */
  java.lang.String getOutputUri();
  /**
   *
   *
   * <pre>
   * 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/`.
   * </pre>
   *
   * <code>string output_uri = 3 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return The bytes for outputUri.
   */
  com.google.protobuf.ByteString getOutputUriBytes();

  /**
   *
   *
   * <pre>
   * 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}`
   * </pre>
   *
   * <code>string template_id = 4 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return Whether the templateId field is set.
   */
  boolean hasTemplateId();
  /**
   *
   *
   * <pre>
   * 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}`
   * </pre>
   *
   * <code>string template_id = 4 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return The templateId.
   */
  java.lang.String getTemplateId();
  /**
   *
   *
   * <pre>
   * 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}`
   * </pre>
   *
   * <code>string template_id = 4 [(.google.api.field_behavior) = INPUT_ONLY];</code>
   *
   * @return The bytes for templateId.
   */
  com.google.protobuf.ByteString getTemplateIdBytes();

  /**
   *
   *
   * <pre>
   * The configuration for this job.
   * </pre>
   *
   * <code>.google.cloud.video.transcoder.v1beta1.JobConfig config = 5;</code>
   *
   * @return Whether the config field is set.
   */
  boolean hasConfig();
  /**
   *
   *
   * <pre>
   * The configuration for this job.
   * </pre>
   *
   * <code>.google.cloud.video.transcoder.v1beta1.JobConfig config = 5;</code>
   *
   * @return The config.
   */
  com.google.cloud.video.transcoder.v1beta1.JobConfig getConfig();
  /**
   *
   *
   * <pre>
   * The configuration for this job.
   * </pre>
   *
   * <code>.google.cloud.video.transcoder.v1beta1.JobConfig config = 5;</code>
   */
  com.google.cloud.video.transcoder.v1beta1.JobConfigOrBuilder getConfigOrBuilder();

  /**
   *
   *
   * <pre>
   * Specify the priority of the job. Enter a value between 0 and 100, where 0
   * is the lowest priority and 100 is the highest priority. The default is 0.
   * </pre>
   *
   * <code>int32 priority = 6;</code>
   *
   * @return The priority.
   */
  int getPriority();

  /**
   *
   *
   * <pre>
   * Output only. The origin URI.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Job.OriginUri origin_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return Whether the originUri field is set.
   */
  boolean hasOriginUri();
  /**
   *
   *
   * <pre>
   * Output only. The origin URI.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Job.OriginUri origin_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The originUri.
   */
  com.google.cloud.video.transcoder.v1beta1.Job.OriginUri getOriginUri();
  /**
   *
   *
   * <pre>
   * Output only. The origin URI.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Job.OriginUri origin_uri = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.cloud.video.transcoder.v1beta1.Job.OriginUriOrBuilder getOriginUriOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. The current state of the job.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Job.ProcessingState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   * <pre>
   * Output only. The current state of the job.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Job.ProcessingState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The state.
   */
  com.google.cloud.video.transcoder.v1beta1.Job.ProcessingState getState();

  /**
   *
   *
   * <pre>
   * Output only. Estimated fractional progress, from `0` to `1` for each
   * step.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Progress progress = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return Whether the progress field is set.
   */
  boolean hasProgress();
  /**
   *
   *
   * <pre>
   * Output only. Estimated fractional progress, from `0` to `1` for each
   * step.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Progress progress = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The progress.
   */
  com.google.cloud.video.transcoder.v1beta1.Progress getProgress();
  /**
   *
   *
   * <pre>
   * Output only. Estimated fractional progress, from `0` to `1` for each
   * step.
   * </pre>
   *
   * <code>
   * .google.cloud.video.transcoder.v1beta1.Progress progress = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.cloud.video.transcoder.v1beta1.ProgressOrBuilder getProgressOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. A description of the reason for the failure. This property is
   * always present when `state` is `FAILED`.
   * </pre>
   *
   * <code>string failure_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The failureReason.
   */
  java.lang.String getFailureReason();
  /**
   *
   *
   * <pre>
   * Output only. A description of the reason for the failure. This property is
   * always present when `state` is `FAILED`.
   * </pre>
   *
   * <code>string failure_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
   *
   * @return The bytes for failureReason.
   */
  com.google.protobuf.ByteString getFailureReasonBytes();

  /**
   *
   *
   * <pre>
   * Output only. List of failure details. This property may contain additional
   * information about the failure when `failure_reason` is present.
   * </pre>
   *
   * <code>
   * repeated .google.cloud.video.transcoder.v1beta1.FailureDetail failure_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  java.util.List<com.google.cloud.video.transcoder.v1beta1.FailureDetail> getFailureDetailsList();
  /**
   *
   *
   * <pre>
   * Output only. List of failure details. This property may contain additional
   * information about the failure when `failure_reason` is present.
   * </pre>
   *
   * <code>
   * repeated .google.cloud.video.transcoder.v1beta1.FailureDetail failure_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.cloud.video.transcoder.v1beta1.FailureDetail getFailureDetails(int index);
  /**
   *
   *
   * <pre>
   * Output only. List of failure details. This property may contain additional
   * information about the failure when `failure_reason` is present.
   * </pre>
   *
   * <code>
   * repeated .google.cloud.video.transcoder.v1beta1.FailureDetail failure_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  int getFailureDetailsCount();
  /**
   *
   *
   * <pre>
   * Output only. List of failure details. This property may contain additional
   * information about the failure when `failure_reason` is present.
   * </pre>
   *
   * <code>
   * repeated .google.cloud.video.transcoder.v1beta1.FailureDetail failure_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  java.util.List<? extends com.google.cloud.video.transcoder.v1beta1.FailureDetailOrBuilder>
      getFailureDetailsOrBuilderList();
  /**
   *
   *
   * <pre>
   * Output only. List of failure details. This property may contain additional
   * information about the failure when `failure_reason` is present.
   * </pre>
   *
   * <code>
   * repeated .google.cloud.video.transcoder.v1beta1.FailureDetail failure_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.cloud.video.transcoder.v1beta1.FailureDetailOrBuilder getFailureDetailsOrBuilder(
      int index);

  /**
   *
   *
   * <pre>
   * Output only. The time the job was created.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   * <pre>
   * Output only. The time the job was created.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   * <pre>
   * Output only. The time the job was created.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. The time the transcoding started.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return Whether the startTime field is set.
   */
  boolean hasStartTime();
  /**
   *
   *
   * <pre>
   * Output only. The time the transcoding started.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The startTime.
   */
  com.google.protobuf.Timestamp getStartTime();
  /**
   *
   *
   * <pre>
   * Output only. The time the transcoding started.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();

  /**
   *
   *
   * <pre>
   * Output only. The time the transcoding finished.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return Whether the endTime field is set.
   */
  boolean hasEndTime();
  /**
   *
   *
   * <pre>
   * Output only. The time the transcoding finished.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   *
   * @return The endTime.
   */
  com.google.protobuf.Timestamp getEndTime();
  /**
   *
   *
   * <pre>
   * Output only. The time the transcoding finished.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * </code>
   */
  com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();

  public com.google.cloud.video.transcoder.v1beta1.Job.JobConfigCase getJobConfigCase();
}