com.google.cloud.video.transcoder.v1.JobOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-video-transcoder-v1 Show documentation
Show all versions of proto-google-cloud-video-transcoder-v1 Show documentation
Proto library for google-cloud-video-transcoder
/*
* Copyright 2024 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/v1/resources.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.video.transcoder.v1;
public interface JobOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.video.transcoder.v1.Job)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The resource name of the job.
* Format: `projects/{project_number}/locations/{location}/jobs/{job}`
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The resource name of the job.
* Format: `projects/{project_number}/locations/{location}/jobs/{job}`
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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];
*
* @return The inputUri.
*/
java.lang.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];
*
* @return The bytes for inputUri.
*/
com.google.protobuf.ByteString getInputUriBytes();
/**
*
*
*
* 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];
*
* @return The outputUri.
*/
java.lang.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];
*
* @return The bytes for outputUri.
*/
com.google.protobuf.ByteString getOutputUriBytes();
/**
*
*
*
* 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];
*
* @return Whether the templateId field is set.
*/
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];
*
* @return The templateId.
*/
java.lang.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];
*
* @return The bytes for templateId.
*/
com.google.protobuf.ByteString getTemplateIdBytes();
/**
*
*
*
* The configuration for this job.
*
*
* .google.cloud.video.transcoder.v1.JobConfig config = 5;
*
* @return Whether the config field is set.
*/
boolean hasConfig();
/**
*
*
*
* The configuration for this job.
*
*
* .google.cloud.video.transcoder.v1.JobConfig config = 5;
*
* @return The config.
*/
com.google.cloud.video.transcoder.v1.JobConfig getConfig();
/**
*
*
*
* The configuration for this job.
*
*
* .google.cloud.video.transcoder.v1.JobConfig config = 5;
*/
com.google.cloud.video.transcoder.v1.JobConfigOrBuilder getConfigOrBuilder();
/**
*
*
*
* Output only. The current state of the job.
*
*
*
* .google.cloud.video.transcoder.v1.Job.ProcessingState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
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];
*
*
* @return The state.
*/
com.google.cloud.video.transcoder.v1.Job.ProcessingState getState();
/**
*
*
*
* Output only. The time the job was created.
*
*
* .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time the job was created.
*
*
* .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time the transcoding started.
*
*
* .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
*
*
* Output only. The time the transcoding started.
*
*
* .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
*
*
* Output only. The time the transcoding started.
*
*
* .google.protobuf.Timestamp start_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* Output only. The time the transcoding finished.
*
*
* .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the endTime field is set.
*/
boolean hasEndTime();
/**
*
*
*
* Output only. The time the transcoding finished.
*
*
* .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The endTime.
*/
com.google.protobuf.Timestamp getEndTime();
/**
*
*
*
* Output only. The time the transcoding finished.
*
*
* .google.protobuf.Timestamp end_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return The ttlAfterCompletionDays.
*/
int getTtlAfterCompletionDays();
/**
*
*
*
* The labels associated with this job. You can use these to organize and
* group your jobs.
*
*
* map<string, string> labels = 16;
*/
int getLabelsCount();
/**
*
*
*
* The labels associated with this job. You can use these to organize and
* group your jobs.
*
*
* map<string, string> labels = 16;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* The labels associated with this job. You can use these to organize and
* group your jobs.
*
*
* map<string, string> labels = 16;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* The labels associated with this job. You can use these to organize and
* group your jobs.
*
*
* map<string, string> labels = 16;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* The labels associated with this job. You can use these to organize and
* group your jobs.
*
*
* map<string, string> labels = 16;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* 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];
*
* @return Whether the error field is set.
*/
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];
*
* @return The error.
*/
com.google.rpc.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];
*/
com.google.rpc.StatusOrBuilder getErrorOrBuilder();
/**
*
*
*
* The processing mode of the job.
* The default is `PROCESSING_MODE_INTERACTIVE`.
*
*
* .google.cloud.video.transcoder.v1.Job.ProcessingMode mode = 20;
*
* @return The enum numeric value on the wire for mode.
*/
int getModeValue();
/**
*
*
*
* The processing mode of the job.
* The default is `PROCESSING_MODE_INTERACTIVE`.
*
*
* .google.cloud.video.transcoder.v1.Job.ProcessingMode mode = 20;
*
* @return The mode.
*/
com.google.cloud.video.transcoder.v1.Job.ProcessingMode getMode();
/**
*
*
*
* 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;
*
* @return The batchModePriority.
*/
int getBatchModePriority();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for optimization.
*/
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];
*
*
* @return The optimization.
*/
com.google.cloud.video.transcoder.v1.Job.OptimizationStrategy getOptimization();
com.google.cloud.video.transcoder.v1.Job.JobConfigCase getJobConfigCase();
}