com.google.api.services.transcoder.v1.model.Job Maven / Gradle / Ivy
/*
* 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
*
* http://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.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.transcoder.v1.model;
/**
* Transcoding job resource.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Transcoder API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class Job extends com.google.api.client.json.GenericJson {
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer batchModePriority;
/**
* The configuration for this job.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private JobConfig config;
/**
* Output only. The time the job was created.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String createTime;
/**
* Output only. The time the transcoding finished.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String endTime;
/**
* Output only. An error object that describes the reason for the failure. This property is always
* present when ProcessingState is `FAILED`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private Status error;
/**
* 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).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String inputUri;
/**
* The labels associated with this job. You can use these to organize and group your jobs.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map labels;
/**
* The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String mode;
/**
* The resource name of the job. Format:
* `projects/{project_number}/locations/{location}/jobs/{job}`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* Optional. The optimization strategy of the job. The default is `AUTODETECT`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String optimization;
/**
* 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).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String outputUri;
/**
* Output only. The time the transcoding started.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String startTime;
/**
* Output only. The current state of the job.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String state;
/**
* 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}`
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String templateId;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer ttlAfterCompletionDays;
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.Integer getBatchModePriority() {
return batchModePriority;
}
/**
* 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.
* @param batchModePriority batchModePriority or {@code null} for none
*/
public Job setBatchModePriority(java.lang.Integer batchModePriority) {
this.batchModePriority = batchModePriority;
return this;
}
/**
* The configuration for this job.
* @return value or {@code null} for none
*/
public JobConfig getConfig() {
return config;
}
/**
* The configuration for this job.
* @param config config or {@code null} for none
*/
public Job setConfig(JobConfig config) {
this.config = config;
return this;
}
/**
* Output only. The time the job was created.
* @return value or {@code null} for none
*/
public String getCreateTime() {
return createTime;
}
/**
* Output only. The time the job was created.
* @param createTime createTime or {@code null} for none
*/
public Job setCreateTime(String createTime) {
this.createTime = createTime;
return this;
}
/**
* Output only. The time the transcoding finished.
* @return value or {@code null} for none
*/
public String getEndTime() {
return endTime;
}
/**
* Output only. The time the transcoding finished.
* @param endTime endTime or {@code null} for none
*/
public Job setEndTime(String endTime) {
this.endTime = endTime;
return this;
}
/**
* Output only. An error object that describes the reason for the failure. This property is always
* present when ProcessingState is `FAILED`.
* @return value or {@code null} for none
*/
public Status getError() {
return error;
}
/**
* Output only. An error object that describes the reason for the failure. This property is always
* present when ProcessingState is `FAILED`.
* @param error error or {@code null} for none
*/
public Job setError(Status error) {
this.error = error;
return this;
}
/**
* 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).
* @return value or {@code null} for none
*/
public java.lang.String getInputUri() {
return inputUri;
}
/**
* 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).
* @param inputUri inputUri or {@code null} for none
*/
public Job setInputUri(java.lang.String inputUri) {
this.inputUri = inputUri;
return this;
}
/**
* The labels associated with this job. You can use these to organize and group your jobs.
* @return value or {@code null} for none
*/
public java.util.Map getLabels() {
return labels;
}
/**
* The labels associated with this job. You can use these to organize and group your jobs.
* @param labels labels or {@code null} for none
*/
public Job setLabels(java.util.Map labels) {
this.labels = labels;
return this;
}
/**
* The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`.
* @return value or {@code null} for none
*/
public java.lang.String getMode() {
return mode;
}
/**
* The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`.
* @param mode mode or {@code null} for none
*/
public Job setMode(java.lang.String mode) {
this.mode = mode;
return this;
}
/**
* The resource name of the job. Format:
* `projects/{project_number}/locations/{location}/jobs/{job}`
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* The resource name of the job. Format:
* `projects/{project_number}/locations/{location}/jobs/{job}`
* @param name name or {@code null} for none
*/
public Job setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* Optional. The optimization strategy of the job. The default is `AUTODETECT`.
* @return value or {@code null} for none
*/
public java.lang.String getOptimization() {
return optimization;
}
/**
* Optional. The optimization strategy of the job. The default is `AUTODETECT`.
* @param optimization optimization or {@code null} for none
*/
public Job setOptimization(java.lang.String optimization) {
this.optimization = optimization;
return this;
}
/**
* 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).
* @return value or {@code null} for none
*/
public java.lang.String getOutputUri() {
return outputUri;
}
/**
* 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).
* @param outputUri outputUri or {@code null} for none
*/
public Job setOutputUri(java.lang.String outputUri) {
this.outputUri = outputUri;
return this;
}
/**
* Output only. The time the transcoding started.
* @return value or {@code null} for none
*/
public String getStartTime() {
return startTime;
}
/**
* Output only. The time the transcoding started.
* @param startTime startTime or {@code null} for none
*/
public Job setStartTime(String startTime) {
this.startTime = startTime;
return this;
}
/**
* Output only. The current state of the job.
* @return value or {@code null} for none
*/
public java.lang.String getState() {
return state;
}
/**
* Output only. The current state of the job.
* @param state state or {@code null} for none
*/
public Job setState(java.lang.String state) {
this.state = state;
return this;
}
/**
* 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}`
* @return value or {@code null} for none
*/
public java.lang.String getTemplateId() {
return templateId;
}
/**
* 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}`
* @param templateId templateId or {@code null} for none
*/
public Job setTemplateId(java.lang.String templateId) {
this.templateId = templateId;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.Integer getTtlAfterCompletionDays() {
return ttlAfterCompletionDays;
}
/**
* 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.
* @param ttlAfterCompletionDays ttlAfterCompletionDays or {@code null} for none
*/
public Job setTtlAfterCompletionDays(java.lang.Integer ttlAfterCompletionDays) {
this.ttlAfterCompletionDays = ttlAfterCompletionDays;
return this;
}
@Override
public Job set(String fieldName, Object value) {
return (Job) super.set(fieldName, value);
}
@Override
public Job clone() {
return (Job) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy