CloudSchedulerClient (Google Cloud Scheduler 2.60.0 API)

java.lang.Object
- com.google.cloud.scheduler.v1beta1.CloudSchedulerClient

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

@BetaApi
 @Generated(value="by gapic-generator-java")
public class CloudSchedulerClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = cloudSchedulerClient.getJob(name);
 }

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

Methods
Method	Description	Method Variants
ListJobs	Lists jobs.	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	Gets a job.	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()
CreateJob	Creates a job.	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()
UpdateJob	Updates a job. If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateJob(UpdateJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateJob(Job job, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateJobCallable()
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()
PauseJob	Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be paused.	Request object method variants only take one parameter, a request object, which must be constructed before the call. pauseJob(PauseJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. pauseJob(JobName name) pauseJob(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. pauseJobCallable()
ResumeJob	Resume a job. This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The state of a job is stored in [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this method it will be set to [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A job must be in [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be resumed.	Request object method variants only take one parameter, a request object, which must be constructed before the call. resumeJob(ResumeJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. resumeJob(JobName name) resumeJob(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. resumeJobCallable()
RunJob	Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.	Request object method variants only take one parameter, a request object, which must be constructed before the call. runJob(RunJobRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. runJob(JobName name) runJob(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. runJobCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 CloudSchedulerSettings 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
 CloudSchedulerSettings cloudSchedulerSettings =
     CloudSchedulerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create(cloudSchedulerSettings);

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
 CloudSchedulerSettings cloudSchedulerSettings =
     CloudSchedulerSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create(cloudSchedulerSettings);

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
 CloudSchedulerSettings cloudSchedulerSettings =
     CloudSchedulerSettings.newHttpJsonBuilder().build();
 CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create(cloudSchedulerSettings);

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`	`CloudSchedulerClient.ListJobsFixedSizeCollection`
`static class`	`CloudSchedulerClient.ListJobsPage`
`static class`	`CloudSchedulerClient.ListJobsPagedResponse`
`static class`	`CloudSchedulerClient.ListLocationsFixedSizeCollection`
`static class`	`CloudSchedulerClient.ListLocationsPage`
`static class`	`CloudSchedulerClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CloudSchedulerClient(CloudSchedulerSettings settings)` Constructs an instance of CloudSchedulerClient, using the given settings.
`protected`	`CloudSchedulerClient(CloudSchedulerStub 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 CloudSchedulerClient`	`create()` Constructs an instance of CloudSchedulerClient with default settings.
`static CloudSchedulerClient`	`create(CloudSchedulerSettings settings)` Constructs an instance of CloudSchedulerClient, using the given settings.
`static CloudSchedulerClient`	`create(CloudSchedulerStub stub)` Constructs an instance of CloudSchedulerClient, using the given stub for making calls.
`Job`	`createJob(CreateJobRequest request)` Creates a job.
`Job`	`createJob(LocationName parent, Job job)` Creates a job.
`Job`	`createJob(String parent, Job job)` Creates a job.
`com.google.api.gax.rpc.UnaryCallable<CreateJobRequest,Job>`	`createJobCallable()` Creates a job.
`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.
`Job`	`getJob(GetJobRequest request)` Gets a job.
`Job`	`getJob(JobName name)` Gets a job.
`Job`	`getJob(String name)` Gets a job.
`com.google.api.gax.rpc.UnaryCallable<GetJobRequest,Job>`	`getJobCallable()` Gets a job.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`CloudSchedulerSettings`	`getSettings()`
`CloudSchedulerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`CloudSchedulerClient.ListJobsPagedResponse`	`listJobs(ListJobsRequest request)` Lists jobs.
`CloudSchedulerClient.ListJobsPagedResponse`	`listJobs(LocationName parent)` Lists jobs.
`CloudSchedulerClient.ListJobsPagedResponse`	`listJobs(String parent)` Lists jobs.
`com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,ListJobsResponse>`	`listJobsCallable()` Lists jobs.
`com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,CloudSchedulerClient.ListJobsPagedResponse>`	`listJobsPagedCallable()` Lists jobs.
`CloudSchedulerClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,CloudSchedulerClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`Job`	`pauseJob(JobName name)` Pauses a job.
`Job`	`pauseJob(PauseJobRequest request)` Pauses a job.
`Job`	`pauseJob(String name)` Pauses a job.
`com.google.api.gax.rpc.UnaryCallable<PauseJobRequest,Job>`	`pauseJobCallable()` Pauses a job.
`Job`	`resumeJob(JobName name)` Resume a job.
`Job`	`resumeJob(ResumeJobRequest request)` Resume a job.
`Job`	`resumeJob(String name)` Resume a job.
`com.google.api.gax.rpc.UnaryCallable<ResumeJobRequest,Job>`	`resumeJobCallable()` Resume a job.
`Job`	`runJob(JobName name)` Forces a job to run now.
`Job`	`runJob(RunJobRequest request)` Forces a job to run now.
`Job`	`runJob(String name)` Forces a job to run now.
`com.google.api.gax.rpc.UnaryCallable<RunJobRequest,Job>`	`runJobCallable()` Forces a job to run now.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Job`	`updateJob(Job job, com.google.protobuf.FieldMask updateMask)` Updates a job.
`Job`	`updateJob(UpdateJobRequest request)` Updates a job.
`com.google.api.gax.rpc.UnaryCallable<UpdateJobRequest,Job>`	`updateJobCallable()` Updates a job.

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

Constructor Detail
- CloudSchedulerClient
```
protected CloudSchedulerClient(CloudSchedulerSettings settings)
                        throws IOException
```
  Constructs an instance of CloudSchedulerClient, 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
- CloudSchedulerClient
```
protected CloudSchedulerClient(CloudSchedulerStub stub)
```

Method Detail

create

public static final CloudSchedulerClient create()
                                         throws IOException

Constructs an instance of CloudSchedulerClient with default settings.

Throws:: IOException

create
```
public static final CloudSchedulerClient create(CloudSchedulerSettings settings)
                                         throws IOException
```
Constructs an instance of CloudSchedulerClient, 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 CloudSchedulerClient create(CloudSchedulerStub stub)
```
Constructs an instance of CloudSchedulerClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudSchedulerSettings).

getSettings

public final CloudSchedulerSettings getSettings()

getStub
```
public CloudSchedulerStub getStub()
```

listJobs

public final CloudSchedulerClient.ListJobsPagedResponse listJobs(LocationName parent)

Lists jobs.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Job element : cloudSchedulerClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listJobs

public final CloudSchedulerClient.ListJobsPagedResponse listJobs(String parent)

Lists jobs.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Job element : cloudSchedulerClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listJobs

public final CloudSchedulerClient.ListJobsPagedResponse listJobs(ListJobsRequest request)

Lists jobs.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLegacyAppEngineCron(true)
           .build();
   for (Job element : cloudSchedulerClient.listJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

listJobsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,CloudSchedulerClient.ListJobsPagedResponse> listJobsPagedCallable()

Lists jobs.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLegacyAppEngineCron(true)
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.listJobsPagedCallable().futureCall(request);
   // Do something.
   for (Job element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listJobsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListJobsRequest,ListJobsResponse> listJobsCallable()

Lists jobs.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLegacyAppEngineCron(true)
           .build();
   while (true) {
     ListJobsResponse response = cloudSchedulerClient.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

public final Job getJob(JobName name)

Gets 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = cloudSchedulerClient.getJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getJob

public final Job getJob(String name)

Gets 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = cloudSchedulerClient.getJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getJob

public final Job getJob(GetJobRequest request)

Gets 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   Job response = cloudSchedulerClient.getJob(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

getJobCallable

public final com.google.api.gax.rpc.UnaryCallable<GetJobRequest,Job> getJobCallable()

Gets 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.getJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

createJob

public final Job createJob(LocationName parent,
                           Job job)

Creates 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   Job response = cloudSchedulerClient.createJob(parent, job);
 }

Parameters:: parent - Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.; job - Required. The job to add. The user can optionally specify a name for the job in [name][google.cloud.scheduler.v1beta1.Job.name]. [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an existing job. If a name is not specified then the system will generate a random unique name that will be returned ([name][google.cloud.scheduler.v1beta1.Job.name]) in the response.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createJob

public final Job createJob(String parent,
                           Job job)

Creates 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Job job = Job.newBuilder().build();
   Job response = cloudSchedulerClient.createJob(parent, job);
 }

Parameters:: parent - Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.; job - Required. The job to add. The user can optionally specify a name for the job in [name][google.cloud.scheduler.v1beta1.Job.name]. [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an existing job. If a name is not specified then the system will generate a random unique name that will be returned ([name][google.cloud.scheduler.v1beta1.Job.name]) in the response.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createJob

public final Job createJob(CreateJobRequest request)

Creates 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .build();
   Job response = cloudSchedulerClient.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.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   CreateJobRequest request =
       CreateJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setJob(Job.newBuilder().build())
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.createJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

updateJob
```
public final Job updateJob(Job job,
                           com.google.protobuf.FieldMask updateMask)
```
Updates a job.
If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does not exist, `NOT_FOUND` is returned.
If UpdateJob does not successfully return, it is possible for the job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.
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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   Job job = Job.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Job response = cloudSchedulerClient.updateJob(job, updateMask);
 }
 
```
Parameters:

job - Required. The new job properties. [name][google.cloud.scheduler.v1beta1.Job.name] must be specified.
Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored.

updateMask - A mask used to specify which fields of the job are being updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateJob

public final Job updateJob(UpdateJobRequest request)

Updates a job.

If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does not exist, `NOT_FOUND` is returned.

If UpdateJob does not successfully return, it is possible for the job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1beta1.Job.State.UPDATE_FAILED] state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setJob(Job.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Job response = cloudSchedulerClient.updateJob(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

updateJobCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateJobRequest,Job> updateJobCallable()

Updates a job.

If successful, the updated [Job][google.cloud.scheduler.v1beta1.Job] is returned. If the job does not exist, `NOT_FOUND` is returned.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   UpdateJobRequest request =
       UpdateJobRequest.newBuilder()
           .setJob(Job.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.updateJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

deleteJob

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   cloudSchedulerClient.deleteJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteJob

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   cloudSchedulerClient.deleteJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteJob

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setLegacyAppEngineCron(true)
           .build();
   cloudSchedulerClient.deleteJob(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

deleteJobCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteJobRequest,com.google.protobuf.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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   DeleteJobRequest request =
       DeleteJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setLegacyAppEngineCron(true)
           .build();
   ApiFuture<Empty> future = cloudSchedulerClient.deleteJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

pauseJob
```
public final Job pauseJob(JobName name)
```
Pauses a job.
If a job is paused then the system will stop executing the job until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be paused.
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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = cloudSchedulerClient.pauseJob(name);
 }
 
```
Parameters:

name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

pauseJob

public final Job pauseJob(String name)

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJob]. The state of the job is stored in [state][google.cloud.scheduler.v1beta1.Job.state]; if paused it will be set to [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED] to be paused.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = cloudSchedulerClient.pauseJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

pauseJob

public final Job pauseJob(PauseJobRequest request)

Pauses 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   PauseJobRequest request =
       PauseJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   Job response = cloudSchedulerClient.pauseJob(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

pauseJobCallable

public final com.google.api.gax.rpc.UnaryCallable<PauseJobRequest,Job> pauseJobCallable()

Pauses 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   PauseJobRequest request =
       PauseJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.pauseJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

resumeJob

public final Job resumeJob(JobName name)

Resume a job.

This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED]. The state of a job is stored in [Job.state][google.cloud.scheduler.v1beta1.Job.state]; after calling this method it will be set to [Job.State.ENABLED][google.cloud.scheduler.v1beta1.Job.State.ENABLED]. A job must be in [Job.State.PAUSED][google.cloud.scheduler.v1beta1.Job.State.PAUSED] to be resumed.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = cloudSchedulerClient.resumeJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

resumeJob

public final Job resumeJob(String name)

Resume 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = cloudSchedulerClient.resumeJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

resumeJob

public final Job resumeJob(ResumeJobRequest request)

Resume 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ResumeJobRequest request =
       ResumeJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   Job response = cloudSchedulerClient.resumeJob(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

resumeJobCallable

public final com.google.api.gax.rpc.UnaryCallable<ResumeJobRequest,Job> resumeJobCallable()

Resume 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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ResumeJobRequest request =
       ResumeJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.resumeJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

runJob

public final Job runJob(JobName name)

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]");
   Job response = cloudSchedulerClient.runJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

runJob

public final Job runJob(String name)

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString();
   Job response = cloudSchedulerClient.runJob(name);
 }

Parameters:: name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

runJob

public final Job runJob(RunJobRequest request)

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   RunJobRequest request =
       RunJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setLegacyAppEngineCron(true)
           .build();
   Job response = cloudSchedulerClient.runJob(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

runJobCallable

public final com.google.api.gax.rpc.UnaryCallable<RunJobRequest,Job> runJobCallable()

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   RunJobRequest request =
       RunJobRequest.newBuilder()
           .setName(JobName.of("[PROJECT]", "[LOCATION]", "[JOB]").toString())
           .setLegacyAppEngineCron(true)
           .build();
   ApiFuture<Job> future = cloudSchedulerClient.runJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

listLocations

public final CloudSchedulerClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : cloudSchedulerClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,CloudSchedulerClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       cloudSchedulerClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = cloudSchedulerClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)

Gets information about a location.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = cloudSchedulerClient.getLocation(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

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()

Gets information about a location.

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 (CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = cloudSchedulerClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class CloudSchedulerClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudSchedulerClient

CloudSchedulerClient

Method Detail

create

create

create

getSettings

getStub

listJobs

listJobs

listJobs

listJobsPagedCallable

listJobsCallable

getJob

getJob

getJob

getJobCallable

createJob

createJob

createJob

createJobCallable

updateJob

updateJob

updateJobCallable

deleteJob

deleteJob

deleteJob

deleteJobCallable

pauseJob

pauseJob

pauseJob

pauseJobCallable

resumeJob

resumeJob

resumeJob

resumeJobCallable

runJob

runJob

runJob

runJobCallable

listLocations

listLocationsPagedCallable

listLocationsCallable

getLocation

getLocationCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination