Class TranscoderServiceClient (1.11.0)

Version 1.11.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.5
• 1.0.4
• 0.4.3

public class TranscoderServiceClient implements BackgroundResource

Service Description: Using the Transcoder API, you can queue asynchronous jobs for transcoding media into various output formats. Output formats may include different streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can also customize jobs using advanced features such as Digital Rights Management (DRM), audio equalization, content concatenation, and digital ad-stitch ready content generation.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   Job response = transcoderServiceClient.createJob(parent, job);
 }
 

Note: close() needs to be called on the TranscoderServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TranscoderServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings transcoderServiceSettings =
     TranscoderServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TranscoderServiceClient transcoderServiceClient =
     TranscoderServiceClient.create(transcoderServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings transcoderServiceSettings =
     TranscoderServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TranscoderServiceClient transcoderServiceClient =
     TranscoderServiceClient.create(transcoderServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings transcoderServiceSettings =
     TranscoderServiceSettings.newHttpJsonBuilder().build();
 TranscoderServiceClient transcoderServiceClient =
     TranscoderServiceClient.create(transcoderServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > TranscoderServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final TranscoderServiceClient create()

Constructs an instance of TranscoderServiceClient with default settings.

Returns

Type	Description
TranscoderServiceClient

Exceptions

Type	Description
IOException

create(TranscoderServiceSettings settings)

public static final TranscoderServiceClient create(TranscoderServiceSettings settings)

Constructs an instance of TranscoderServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	TranscoderServiceSettings

Returns

Type	Description
TranscoderServiceClient

Exceptions

Type	Description
IOException

create(TranscoderServiceStub stub)

public static final TranscoderServiceClient create(TranscoderServiceStub stub)

Constructs an instance of TranscoderServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TranscoderServiceSettings).

Parameter

Name	Description
stub	TranscoderServiceStub

Returns

Type	Description
TranscoderServiceClient

Constructors

TranscoderServiceClient(TranscoderServiceSettings settings)

protected TranscoderServiceClient(TranscoderServiceSettings settings)

Constructs an instance of TranscoderServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	TranscoderServiceSettings

TranscoderServiceClient(TranscoderServiceStub stub)

protected TranscoderServiceClient(TranscoderServiceStub stub)

Parameter

Name	Description
stub	TranscoderServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createJob(CreateJobRequest request)

public final Job createJob(CreateJobRequest request)

Creates a job in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .build();
   Job response = transcoderServiceClient.createJob(request);
 }
 

Parameter

Name	Description
request	CreateJobRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Job

createJob(LocationName parent, Job job)

public final Job createJob(LocationName parent, Job job)

Creates a job in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   Job response = transcoderServiceClient.createJob(parent, job);
 }
 

Parameters

Name	Description
parent	LocationName Required. The parent location to create and process this job. Format: projects/{project}/locations/{location}
job	Job Required. Parameters for creating transcoding job.

Returns

Type	Description
Job

createJob(String parent, Job job)

public final Job createJob(String parent, Job job)

Creates a job in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Job job = Job.newBuilder().build();
   Job response = transcoderServiceClient.createJob(parent, job);
 }
 

Parameters

Name	Description
parent	String Required. The parent location to create and process this job. Format: projects/{project}/locations/{location}
job	Job Required. Parameters for creating transcoding job.

Returns

Type	Description
Job

createJobCallable()

public final UnaryCallable<CreateJobRequest,Job> createJobCallable()

Creates a job in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .build();
   ApiFuture<Job> future = transcoderServiceClient.createJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateJobRequest,Job>

createJobTemplate(CreateJobTemplateRequest request)

public final JobTemplate createJobTemplate(CreateJobTemplateRequest request)

Creates a job template in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   CreateJobTemplateRequest request =
       CreateJobTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJobTemplate(JobTemplate.newBuilder().build())
           .setJobTemplateId("jobTemplateId-597733678")
           .build();
   JobTemplate response = transcoderServiceClient.createJobTemplate(request);
 }
 

Parameter

Name	Description
request	CreateJobTemplateRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
JobTemplate

createJobTemplate(LocationName parent, JobTemplate jobTemplate, String jobTemplateId)

public final JobTemplate createJobTemplate(LocationName parent, JobTemplate jobTemplate, String jobTemplateId)

Creates a job template in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   JobTemplate jobTemplate = JobTemplate.newBuilder().build();
   String jobTemplateId = "jobTemplateId-597733678";
   JobTemplate response =
       transcoderServiceClient.createJobTemplate(parent, jobTemplate, jobTemplateId);
 }
 

Parameters

Name	Description
parent	LocationName Required. The parent location to create this job template. Format: projects/{project}/locations/{location}
jobTemplate	JobTemplate Required. Parameters for creating job template.
jobTemplateId	String Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression a-zA-Z*.

Returns

Type	Description
JobTemplate

createJobTemplate(String parent, JobTemplate jobTemplate, String jobTemplateId)

public final JobTemplate createJobTemplate(String parent, JobTemplate jobTemplate, String jobTemplateId)

Creates a job template in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   JobTemplate jobTemplate = JobTemplate.newBuilder().build();
   String jobTemplateId = "jobTemplateId-597733678";
   JobTemplate response =
       transcoderServiceClient.createJobTemplate(parent, jobTemplate, jobTemplateId);
 }
 

Parameters

Name	Description
parent	String Required. The parent location to create this job template. Format: projects/{project}/locations/{location}
jobTemplate	JobTemplate Required. Parameters for creating job template.
jobTemplateId	String Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression a-zA-Z*.

Returns

Type	Description
JobTemplate

createJobTemplateCallable()

public final UnaryCallable<CreateJobTemplateRequest,JobTemplate> createJobTemplateCallable()

Creates a job template in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   CreateJobTemplateRequest request =
       CreateJobTemplateRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJobTemplate(JobTemplate.newBuilder().build())
           .setJobTemplateId("jobTemplateId-597733678")
           .build();
   ApiFuture<JobTemplate> future =
       transcoderServiceClient.createJobTemplateCallable().futureCall(request);
   // Do something.
   JobTemplate response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateJobTemplateRequest,JobTemplate>

deleteJob(DeleteJobRequest request)

public final void deleteJob(DeleteJobRequest request)

Deletes a job.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setAllowMissing(true)
           .build();
   transcoderServiceClient.deleteJob(request);
 }
 

Parameter

Name	Description
request	DeleteJobRequest The request object containing all of the parameters for the API call.

deleteJob(JobName name)

public final void deleteJob(JobName name)

Deletes a job.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   transcoderServiceClient.deleteJob(name);
 }
 

Parameter

Name	Description
name	JobName Required. The name of the job to delete. Format: projects/{project}/locations/{location}/jobs/{job}

deleteJob(String name)

public final void deleteJob(String name)

Deletes a job.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   transcoderServiceClient.deleteJob(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the job to delete. Format: projects/{project}/locations/{location}/jobs/{job}

deleteJobCallable()

public final UnaryCallable<DeleteJobRequest,Empty> deleteJobCallable()

Deletes a job.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setAllowMissing(true)
           .build();
   ApiFuture<Empty> future = transcoderServiceClient.deleteJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteJobRequest,Empty>

deleteJobTemplate(DeleteJobTemplateRequest request)

public final void deleteJobTemplate(DeleteJobTemplateRequest request)

Deletes a job template.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   DeleteJobTemplateRequest request =
       DeleteJobTemplateRequest.newBuilder()
           .setName(JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]").toString())
           .setAllowMissing(true)
           .build();
   transcoderServiceClient.deleteJobTemplate(request);
 }
 

Parameter

Name	Description
request	DeleteJobTemplateRequest The request object containing all of the parameters for the API call.

deleteJobTemplate(JobTemplateName name)

public final void deleteJobTemplate(JobTemplateName name)

Deletes a job template.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   JobTemplateName name = JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]");
   transcoderServiceClient.deleteJobTemplate(name);
 }
 

Parameter

Name	Description
name	JobTemplateName Required. The name of the job template to delete. projects/{project}/locations/{location}/jobTemplates/{job_template}

deleteJobTemplate(String name)

public final void deleteJobTemplate(String name)

Deletes a job template.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String name = JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]").toString();
   transcoderServiceClient.deleteJobTemplate(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the job template to delete. projects/{project}/locations/{location}/jobTemplates/{job_template}

deleteJobTemplateCallable()

public final UnaryCallable<DeleteJobTemplateRequest,Empty> deleteJobTemplateCallable()

Deletes a job template.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   DeleteJobTemplateRequest request =
       DeleteJobTemplateRequest.newBuilder()
           .setName(JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]").toString())
           .setAllowMissing(true)
           .build();
   ApiFuture<Empty> future =
       transcoderServiceClient.deleteJobTemplateCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteJobTemplateRequest,Empty>

getJob(GetJobRequest request)

public final Job getJob(GetJobRequest request)

Returns the job data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   Job response = transcoderServiceClient.getJob(request);
 }
 

Parameter

Name	Description
request	GetJobRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Job

getJob(JobName name)

public final Job getJob(JobName name)

Returns the job data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = transcoderServiceClient.getJob(name);
 }
 

Parameter

Name	Description
name	JobName Required. The name of the job to retrieve. Format: projects/{project}/locations/{location}/jobs/{job}

Returns

Type	Description
Job

getJob(String name)

public final Job getJob(String name)

Returns the job data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = transcoderServiceClient.getJob(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the job to retrieve. Format: projects/{project}/locations/{location}/jobs/{job}

Returns

Type	Description
Job

getJobCallable()

public final UnaryCallable<GetJobRequest,Job> getJobCallable()

Returns the job data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   ApiFuture<Job> future = transcoderServiceClient.getJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetJobRequest,Job>

getJobTemplate(GetJobTemplateRequest request)

public final JobTemplate getJobTemplate(GetJobTemplateRequest request)

Returns the job template data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   GetJobTemplateRequest request =
       GetJobTemplateRequest.newBuilder()
           .setName(JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]").toString())
           .build();
   JobTemplate response = transcoderServiceClient.getJobTemplate(request);
 }
 

Parameter

Name	Description
request	GetJobTemplateRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
JobTemplate

getJobTemplate(JobTemplateName name)

public final JobTemplate getJobTemplate(JobTemplateName name)

Returns the job template data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   JobTemplateName name = JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]");
   JobTemplate response = transcoderServiceClient.getJobTemplate(name);
 }
 

Parameter

Name	Description
name	JobTemplateName Required. The name of the job template to retrieve. Format: projects/{project}/locations/{location}/jobTemplates/{job_template}

Returns

Type	Description
JobTemplate

getJobTemplate(String name)

public final JobTemplate getJobTemplate(String name)

Returns the job template data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String name = JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]").toString();
   JobTemplate response = transcoderServiceClient.getJobTemplate(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the job template to retrieve. Format: projects/{project}/locations/{location}/jobTemplates/{job_template}

Returns

Type	Description
JobTemplate

getJobTemplateCallable()

public final UnaryCallable<GetJobTemplateRequest,JobTemplate> getJobTemplateCallable()

Returns the job template data.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   GetJobTemplateRequest request =
       GetJobTemplateRequest.newBuilder()
           .setName(JobTemplateName.of("[PROJECT]", "[LOCATION]", "[JOB_TEMPLATE]").toString())
           .build();
   ApiFuture<JobTemplate> future =
       transcoderServiceClient.getJobTemplateCallable().futureCall(request);
   // Do something.
   JobTemplate response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetJobTemplateRequest,JobTemplate>

getSettings()

public final TranscoderServiceSettings getSettings()

Returns

Type	Description
TranscoderServiceSettings

getStub()

public TranscoderServiceStub getStub()

Returns

Type	Description
TranscoderServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listJobTemplates(ListJobTemplatesRequest request)

public final TranscoderServiceClient.ListJobTemplatesPagedResponse listJobTemplates(ListJobTemplatesRequest request)

Lists job templates in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   ListJobTemplatesRequest request =
       ListJobTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (JobTemplate element : transcoderServiceClient.listJobTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListJobTemplatesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TranscoderServiceClient.ListJobTemplatesPagedResponse

listJobTemplates(LocationName parent)

public final TranscoderServiceClient.ListJobTemplatesPagedResponse listJobTemplates(LocationName parent)

Lists job templates in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (JobTemplate element : transcoderServiceClient.listJobTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	LocationName Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}

Returns

Type	Description
TranscoderServiceClient.ListJobTemplatesPagedResponse

listJobTemplates(String parent)

public final TranscoderServiceClient.ListJobTemplatesPagedResponse listJobTemplates(String parent)

Lists job templates in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (JobTemplate element : transcoderServiceClient.listJobTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}

Returns

Type	Description
TranscoderServiceClient.ListJobTemplatesPagedResponse

listJobTemplatesCallable()

public final UnaryCallable<ListJobTemplatesRequest,ListJobTemplatesResponse> listJobTemplatesCallable()

Lists job templates in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   ListJobTemplatesRequest request =
       ListJobTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListJobTemplatesResponse response =
         transcoderServiceClient.listJobTemplatesCallable().call(request);
     for (JobTemplate element : response.getJobTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListJobTemplatesRequest,ListJobTemplatesResponse>

listJobTemplatesPagedCallable()

public final UnaryCallable<ListJobTemplatesRequest,TranscoderServiceClient.ListJobTemplatesPagedResponse> listJobTemplatesPagedCallable()

Lists job templates in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   ListJobTemplatesRequest request =
       ListJobTemplatesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<JobTemplate> future =
       transcoderServiceClient.listJobTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (JobTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListJobTemplatesRequest,ListJobTemplatesPagedResponse>

listJobs(ListJobsRequest request)

public final TranscoderServiceClient.ListJobsPagedResponse listJobs(ListJobsRequest request)

Lists jobs in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Job element : transcoderServiceClient.listJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListJobsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TranscoderServiceClient.ListJobsPagedResponse

listJobs(LocationName parent)

public final TranscoderServiceClient.ListJobsPagedResponse listJobs(LocationName parent)

Lists jobs in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Job element : transcoderServiceClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	LocationName Required. Format: projects/{project}/locations/{location}

Returns

Type	Description
TranscoderServiceClient.ListJobsPagedResponse

listJobs(String parent)

public final TranscoderServiceClient.ListJobsPagedResponse listJobs(String parent)

Lists jobs in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Job element : transcoderServiceClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. Format: projects/{project}/locations/{location}

Returns

Type	Description
TranscoderServiceClient.ListJobsPagedResponse

listJobsCallable()

public final UnaryCallable<ListJobsRequest,ListJobsResponse> listJobsCallable()

Lists jobs in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListJobsResponse response = transcoderServiceClient.listJobsCallable().call(request);
     for (Job element : response.getJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListJobsRequest,ListJobsResponse>

listJobsPagedCallable()

public final UnaryCallable<ListJobsRequest,TranscoderServiceClient.ListJobsPagedResponse> listJobsPagedCallable()

Lists jobs in the specified region.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Job> future = transcoderServiceClient.listJobsPagedCallable().futureCall(request);
   // Do something.
   for (Job element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListJobsRequest,ListJobsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()