TranscoderServiceClient (Google Video Transcoder 1.32.0 API)

java.lang.Object
- com.google.cloud.video.transcoder.v1.TranscoderServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class TranscoderServiceClient
extends Object
implements com.google.api.gax.core.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().

Method	Description	Method Variants
CreateJob	Creates a job in the specified region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createJob(CreateJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createJob(LocationName parent, Job job) createJob(String parent, Job job) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createJobCallable()
ListJobs	Lists jobs in the specified region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listJobs(ListJobsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listJobs(LocationName parent) listJobs(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listJobsPagedCallable() listJobsCallable()
GetJob	Returns the job data.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getJob(GetJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getJob(JobName name) getJob(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getJobCallable()
DeleteJob	Deletes a job.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteJob(DeleteJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteJob(JobName name) deleteJob(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteJobCallable()
CreateJobTemplate	Creates a job template in the specified region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createJobTemplate(CreateJobTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createJobTemplate(LocationName parent, JobTemplate jobTemplate, String jobTemplateId) createJobTemplate(String parent, JobTemplate jobTemplate, String jobTemplateId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createJobTemplateCallable()
ListJobTemplates	Lists job templates in the specified region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listJobTemplates(ListJobTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listJobTemplates(LocationName parent) listJobTemplates(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listJobTemplatesPagedCallable() listJobTemplatesCallable()
GetJobTemplate	Returns the job template data.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getJobTemplate(GetJobTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getJobTemplate(JobTemplateName name) getJobTemplate(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getJobTemplateCallable()
DeleteJobTemplate	Deletes a job template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteJobTemplate(DeleteJobTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteJobTemplate(JobTemplateName name) deleteJobTemplate(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteJobTemplateCallable()

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TranscoderServiceClient.ListJobsFixedSizeCollection`
`static class`	`TranscoderServiceClient.ListJobsPage`
`static class`	`TranscoderServiceClient.ListJobsPagedResponse`
`static class`	`TranscoderServiceClient.ListJobTemplatesFixedSizeCollection`
`static class`	`TranscoderServiceClient.ListJobTemplatesPage`
`static class`	`TranscoderServiceClient.ListJobTemplatesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TranscoderServiceClient(TranscoderServiceSettings settings)` Constructs an instance of TranscoderServiceClient, using the given settings.
`protected`	`TranscoderServiceClient(TranscoderServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static TranscoderServiceClient`	`create()` Constructs an instance of TranscoderServiceClient with default settings.
`static TranscoderServiceClient`	`create(TranscoderServiceSettings settings)` Constructs an instance of TranscoderServiceClient, using the given settings.
`static TranscoderServiceClient`	`create(TranscoderServiceStub stub)` Constructs an instance of TranscoderServiceClient, using the given stub for making calls.
`Job`	`createJob(CreateJobRequest request)` Creates a job in the specified region.
`Job`	`createJob(LocationName parent, Job job)` Creates a job in the specified region.
`Job`	`createJob(String parent, Job job)` Creates a job in the specified region.
`com.google.api.gax.rpc.UnaryCallable<CreateJobRequest,Job>`	`createJobCallable()` Creates a job in the specified region.
`JobTemplate`	`createJobTemplate(CreateJobTemplateRequest request)` Creates a job template in the specified region.
`JobTemplate`	`createJobTemplate(LocationName parent, JobTemplate jobTemplate, String jobTemplateId)` Creates a job template in the specified region.
`JobTemplate`	`createJobTemplate(String parent, JobTemplate jobTemplate, String jobTemplateId)` Creates a job template in the specified region.
`com.google.api.gax.rpc.UnaryCallable<CreateJobTemplateRequest,JobTemplate>`	`createJobTemplateCallable()` Creates a job template in the specified region.
`void`	`deleteJob(DeleteJobRequest request)` Deletes a job.
`void`	`deleteJob(JobName name)` Deletes a job.
`void`	`deleteJob(String name)` Deletes a job.
`com.google.api.gax.rpc.UnaryCallable<DeleteJobRequest,com.google.protobuf.Empty>`	`deleteJobCallable()` Deletes a job.
`void`	`deleteJobTemplate(DeleteJobTemplateRequest request)` Deletes a job template.
`void`	`deleteJobTemplate(JobTemplateName name)` Deletes a job template.
`void`	`deleteJobTemplate(String name)` Deletes a job template.
`com.google.api.gax.rpc.UnaryCallable<DeleteJobTemplateRequest,com.google.protobuf.Empty>`	`deleteJobTemplateCallable()` Deletes a job template.
`Job`	`getJob(GetJobRequest request)` Returns the job data.
`Job`	`getJob(JobName name)` Returns the job data.
`Job`	`getJob(String name)` Returns the job data.
`com.google.api.gax.rpc.UnaryCallable<GetJobRequest,Job>`	`getJobCallable()` Returns the job data.
`JobTemplate`	`getJobTemplate(GetJobTemplateRequest request)` Returns the job template data.
`JobTemplate`	`getJobTemplate(JobTemplateName name)` Returns the job template data.
`JobTemplate`	`getJobTemplate(String name)` Returns the job template data.
`com.google.api.gax.rpc.UnaryCallable<GetJobTemplateRequest,JobTemplate>`	`getJobTemplateCallable()` Returns the job template data.
`TranscoderServiceSettings`	`getSettings()`
`TranscoderServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TranscoderServiceClient.ListJobsPagedResponse`	`listJobs(ListJobsRequest request)` Lists jobs in the specified region.
`TranscoderServiceClient.ListJobsPagedResponse`	`listJobs(LocationName parent)` Lists jobs in the specified region.
`TranscoderServiceClient.ListJobsPagedResponse`	`listJobs(String parent)` Lists jobs in the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,ListJobsResponse>`	`listJobsCallable()` Lists jobs in the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,TranscoderServiceClient.ListJobsPagedResponse>`	`listJobsPagedCallable()` Lists jobs in the specified region.
`TranscoderServiceClient.ListJobTemplatesPagedResponse`	`listJobTemplates(ListJobTemplatesRequest request)` Lists job templates in the specified region.
`TranscoderServiceClient.ListJobTemplatesPagedResponse`	`listJobTemplates(LocationName parent)` Lists job templates in the specified region.
`TranscoderServiceClient.ListJobTemplatesPagedResponse`	`listJobTemplates(String parent)` Lists job templates in the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListJobTemplatesRequest,ListJobTemplatesResponse>`	`listJobTemplatesCallable()` Lists job templates in the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListJobTemplatesRequest,TranscoderServiceClient.ListJobTemplatesPagedResponse>`	`listJobTemplatesPagedCallable()` Lists job templates in the specified region.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TranscoderServiceClient
```
protected TranscoderServiceClient(TranscoderServiceSettings settings)
                           throws IOException
```
  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.
  
  Throws:
  
  IOException
- TranscoderServiceClient
```
protected TranscoderServiceClient(TranscoderServiceStub stub)
```

Method Detail

create

public static final TranscoderServiceClient create()
                                            throws IOException

Constructs an instance of TranscoderServiceClient with default settings.

Throws:: IOException

create
```
public static final TranscoderServiceClient create(TranscoderServiceSettings settings)
                                            throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final TranscoderServiceSettings getSettings()

getStub

public TranscoderServiceStub getStub()

createJob

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:: parent - Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`; job - Required. Parameters for creating transcoding job.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createJob

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:: parent - Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`; job - Required. Parameters for creating transcoding job.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createJob

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createJobCallable

public final com.google.api.gax.rpc.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();
 }