Class TranscoderServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetJob |
Returns the job data. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteJob |
Deletes a job. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetJobTemplate |
Returns the job template data. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteJobTemplate |
Deletes a job template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotectedConstructs an instance of TranscoderServiceClient, using the given settings. -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final TranscoderServiceClientcreate()Constructs an instance of TranscoderServiceClient with default settings.static final TranscoderServiceClientcreate(TranscoderServiceStub stub) Constructs an instance of TranscoderServiceClient, using the given stub for making calls.static final TranscoderServiceClientcreate(TranscoderServiceSettings settings) Constructs an instance of TranscoderServiceClient, using the given settings.final JobcreateJob(CreateJobRequest request) Creates a job in the specified region.final JobcreateJob(LocationName parent, Job job) Creates a job in the specified region.final JobCreates a job in the specified region.final UnaryCallable<CreateJobRequest,Job> Creates a job in the specified region.final JobTemplateCreates a job template in the specified region.final JobTemplatecreateJobTemplate(LocationName parent, JobTemplate jobTemplate, String jobTemplateId) Creates a job template in the specified region.final JobTemplatecreateJobTemplate(String parent, JobTemplate jobTemplate, String jobTemplateId) Creates a job template in the specified region.Creates a job template in the specified region.final voiddeleteJob(DeleteJobRequest request) Deletes a job.final voidDeletes a job.final voidDeletes a job.final UnaryCallable<DeleteJobRequest,com.google.protobuf.Empty> Deletes a job.final voidDeletes a job template.final voidDeletes a job template.final voiddeleteJobTemplate(String name) Deletes a job template.final UnaryCallable<DeleteJobTemplateRequest,com.google.protobuf.Empty> Deletes a job template.final JobgetJob(GetJobRequest request) Returns the job data.final JobReturns the job data.final JobReturns the job data.final UnaryCallable<GetJobRequest,Job> Returns the job data.final JobTemplategetJobTemplate(GetJobTemplateRequest request) Returns the job template data.final JobTemplateReturns the job template data.final JobTemplategetJobTemplate(String name) Returns the job template data.Returns the job template data.getStub()booleanbooleanlistJobs(ListJobsRequest request) Lists jobs in the specified region.listJobs(LocationName parent) Lists jobs in the specified region.Lists jobs in the specified region.Lists jobs in the specified region.Lists jobs in the specified region.listJobTemplates(ListJobTemplatesRequest request) Lists job templates in the specified region.listJobTemplates(LocationName parent) Lists job templates in the specified region.listJobTemplates(String parent) Lists job templates in the specified region.Lists job templates in the specified region.Lists job templates in the specified region.voidshutdown()void
-
Constructor Details
-
TranscoderServiceClient
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
-
-
Method Details
-
create
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
Constructs an instance of TranscoderServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TranscoderServiceSettings). -
getSettings
-
getStub
-
createJob
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:
ApiException- if the remote call fails
-
createJob
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:
ApiException- if the remote call fails
-
createJob
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:
ApiException- if the remote call fails
-
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(); } -
listJobs
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); } }- Parameters:
parent- Required. Format: `projects/{project}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listJobs
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); } }- Parameters:
parent- Required. Format: `projects/{project}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listJobs
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getJob
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); }- Parameters:
name- Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`- Throws:
ApiException- if the remote call fails
-
getJob
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); }- Parameters:
name- Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`- Throws:
ApiException- if the remote call fails
-
getJob
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
deleteJob
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); }- Parameters:
name- Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`- Throws:
ApiException- if the remote call fails
-
deleteJob
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); }- Parameters:
name- Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`- Throws:
ApiException- if the remote call fails
-
deleteJob
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
createJobTemplate
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:
parent- Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`jobTemplate- Required. Parameters for creating job template.jobTemplateId- 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][a-zA-Z0-9_-]*`.
- Throws:
ApiException- if the remote call fails
-
createJobTemplate
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:
parent- Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`jobTemplate- Required. Parameters for creating job template.jobTemplateId- 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][a-zA-Z0-9_-]*`.
- Throws:
ApiException- if the remote call fails
-
createJobTemplate
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listJobTemplates
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); } }- Parameters:
parent- Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listJobTemplates
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); } }- Parameters:
parent- Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listJobTemplates
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getJobTemplate
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); }- Parameters:
name- Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`- Throws:
ApiException- if the remote call fails
-
getJobTemplate
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); }- Parameters:
name- Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`- Throws:
ApiException- if the remote call fails
-
getJobTemplate
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
deleteJobTemplate
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); }- Parameters:
name- Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`- Throws:
ApiException- if the remote call fails
-
deleteJobTemplate
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); }- Parameters:
name- Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`- Throws:
ApiException- if the remote call fails
-
deleteJobTemplate
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteJobTemplateCallable
public final UnaryCallable<DeleteJobTemplateRequest,com.google.protobuf.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(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-