com.google.cloud.scheduler.v1.CloudSchedulerClient Maven / Gradle / Ivy
Show all versions of google-cloud-scheduler Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.scheduler.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.cloud.scheduler.v1.stub.CloudSchedulerStub;
import com.google.cloud.scheduler.v1.stub.CloudSchedulerStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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);
* }
* }
*
* 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.v1.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.v1.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.v1.CloudScheduler.ResumeJob]. The state of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if paused it will be set to [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1.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.v1.Job.State.PAUSED]. The state of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it will be set to [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in [Job.State.PAUSED][google.cloud.scheduler.v1.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:
*
*
{@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
* CloudSchedulerSettings cloudSchedulerSettings =
* CloudSchedulerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create(cloudSchedulerSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* CloudSchedulerSettings cloudSchedulerSettings =
* CloudSchedulerSettings.newHttpJsonBuilder().build();
* CloudSchedulerClient cloudSchedulerClient = CloudSchedulerClient.create(cloudSchedulerSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class CloudSchedulerClient implements BackgroundResource {
private final CloudSchedulerSettings settings;
private final CloudSchedulerStub stub;
/** Constructs an instance of CloudSchedulerClient with default settings. */
public static final CloudSchedulerClient create() throws IOException {
return create(CloudSchedulerSettings.newBuilder().build());
}
/**
* 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.
*/
public static final CloudSchedulerClient create(CloudSchedulerSettings settings)
throws IOException {
return new CloudSchedulerClient(settings);
}
/**
* Constructs an instance of CloudSchedulerClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(CloudSchedulerSettings).
*/
public static final CloudSchedulerClient create(CloudSchedulerStub stub) {
return new CloudSchedulerClient(stub);
}
/**
* 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.
*/
protected CloudSchedulerClient(CloudSchedulerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((CloudSchedulerStubSettings) settings.getStubSettings()).createStub();
}
protected CloudSchedulerClient(CloudSchedulerStub stub) {
this.settings = null;
this.stub = stub;
}
public final CloudSchedulerSettings getSettings() {
return settings;
}
public CloudSchedulerStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists jobs.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListJobsPagedResponse listJobs(LocationName parent) {
ListJobsRequest request =
ListJobsRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return listJobs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists jobs.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListJobsPagedResponse listJobs(String parent) {
ListJobsRequest request = ListJobsRequest.newBuilder().setParent(parent).build();
return listJobs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists jobs.
*
* Sample code:
*
*
{@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())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Job element : cloudSchedulerClient.listJobs(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListJobsPagedResponse listJobs(ListJobsRequest request) {
return listJobsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists jobs.
*
* Sample code:
*
*
{@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())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future = cloudSchedulerClient.listJobsPagedCallable().futureCall(request);
* // Do something.
* for (Job element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable listJobsPagedCallable() {
return stub.listJobsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists jobs.
*
* Sample code:
*
*
{@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())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .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;
* }
* }
* }
* }
*/
public final UnaryCallable listJobsCallable() {
return stub.listJobsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job getJob(JobName name) {
GetJobRequest request =
GetJobRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job getJob(String name) {
GetJobRequest request = GetJobRequest.newBuilder().setName(name).build();
return getJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job getJob(GetJobRequest request) {
return getJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a job.
*
* Sample code:
*
*
{@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 future = cloudSchedulerClient.getJobCallable().futureCall(request);
* // Do something.
* Job response = future.get();
* }
* }
*/
public final UnaryCallable getJobCallable() {
return stub.getJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The location name. For example:
* `projects/PROJECT_ID/locations/LOCATION_ID`.
* @param job Required. The job to add. The user can optionally specify a name for the job in
* [name][google.cloud.scheduler.v1.Job.name]. [name][google.cloud.scheduler.v1.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.v1.Job.name]) in the response.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Job createJob(LocationName parent, Job job) {
CreateJobRequest request =
CreateJobRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setJob(job)
.build();
return createJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The location name. For example:
* `projects/PROJECT_ID/locations/LOCATION_ID`.
* @param job Required. The job to add. The user can optionally specify a name for the job in
* [name][google.cloud.scheduler.v1.Job.name]. [name][google.cloud.scheduler.v1.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.v1.Job.name]) in the response.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Job createJob(String parent, Job job) {
CreateJobRequest request = CreateJobRequest.newBuilder().setParent(parent).setJob(job).build();
return createJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job createJob(CreateJobRequest request) {
return createJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a job.
*
* Sample code:
*
*
{@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 future = cloudSchedulerClient.createJobCallable().futureCall(request);
* // Do something.
* Job response = future.get();
* }
* }
*/
public final UnaryCallable createJobCallable() {
return stub.createJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a job.
*
* If successful, the updated [Job][google.cloud.scheduler.v1.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.v1.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:
*
*
{@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);
* }
* }
*
* @param job Required. The new job properties. [name][google.cloud.scheduler.v1.Job.name] must be
* specified.
* Output only fields cannot be modified using UpdateJob. Any value specified for an output
* only field will be ignored.
* @param 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
*/
public final Job updateJob(Job job, FieldMask updateMask) {
UpdateJobRequest request =
UpdateJobRequest.newBuilder().setJob(job).setUpdateMask(updateMask).build();
return updateJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a job.
*
*
If successful, the updated [Job][google.cloud.scheduler.v1.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.v1.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:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job updateJob(UpdateJobRequest request) {
return updateJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a job.
*
* If successful, the updated [Job][google.cloud.scheduler.v1.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.v1.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:
*
*
{@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 future = cloudSchedulerClient.updateJobCallable().futureCall(request);
* // Do something.
* Job response = future.get();
* }
* }
*/
public final UnaryCallable updateJobCallable() {
return stub.updateJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteJob(JobName name) {
DeleteJobRequest request =
DeleteJobRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a job.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final void deleteJob(String name) {
DeleteJobRequest request = DeleteJobRequest.newBuilder().setName(name).build();
deleteJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a job.
*
* Sample code:
*
*
{@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())
* .build();
* cloudSchedulerClient.deleteJob(request);
* }
* }
*
* @param 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
*/
public final void deleteJob(DeleteJobRequest request) {
deleteJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a job.
*
* Sample code:
*
*
{@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())
* .build();
* ApiFuture future = cloudSchedulerClient.deleteJobCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteJobCallable() {
return stub.deleteJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.v1.CloudScheduler.ResumeJob]. The state of the job is stored
* in [state][google.cloud.scheduler.v1.Job.state]; if paused it will be set to
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to be paused.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job pauseJob(JobName name) {
PauseJobRequest request =
PauseJobRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return pauseJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.v1.CloudScheduler.ResumeJob]. The state of the job is stored
* in [state][google.cloud.scheduler.v1.Job.state]; if paused it will be set to
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to be paused.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job pauseJob(String name) {
PauseJobRequest request = PauseJobRequest.newBuilder().setName(name).build();
return pauseJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.v1.CloudScheduler.ResumeJob]. The state of the job is stored
* in [state][google.cloud.scheduler.v1.Job.state]; if paused it will be set to
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to be paused.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job pauseJob(PauseJobRequest request) {
return pauseJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.v1.CloudScheduler.ResumeJob]. The state of the job is stored
* in [state][google.cloud.scheduler.v1.Job.state]; if paused it will be set to
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to be paused.
*
*
Sample code:
*
*
{@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 future = cloudSchedulerClient.pauseJobCallable().futureCall(request);
* // Do something.
* Job response = future.get();
* }
* }
*/
public final UnaryCallable pauseJobCallable() {
return stub.pauseJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resume a job.
*
* This method reenables a job after it has been
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state of a job is stored in
* [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it will be set to
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job resumeJob(JobName name) {
ResumeJobRequest request =
ResumeJobRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return resumeJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resume a job.
*
* This method reenables a job after it has been
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state of a job is stored in
* [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it will be set to
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job resumeJob(String name) {
ResumeJobRequest request = ResumeJobRequest.newBuilder().setName(name).build();
return resumeJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resume a job.
*
* This method reenables a job after it has been
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state of a job is stored in
* [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it will be set to
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job resumeJob(ResumeJobRequest request) {
return resumeJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resume a job.
*
* This method reenables a job after it has been
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state of a job is stored in
* [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it will be set to
* [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in
* [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.
*
*
Sample code:
*
*
{@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 future = cloudSchedulerClient.resumeJobCallable().futureCall(request);
* // Do something.
* Job response = future.get();
* }
* }
*/
public final UnaryCallable resumeJobCallable() {
return stub.resumeJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job runJob(JobName name) {
RunJobRequest request =
RunJobRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return runJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Job runJob(String name) {
RunJobRequest request = RunJobRequest.newBuilder().setName(name).build();
return runJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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())
* .build();
* Job response = cloudSchedulerClient.runJob(request);
* }
* }
*
* @param 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
*/
public final Job runJob(RunJobRequest request) {
return runJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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())
* .build();
* ApiFuture future = cloudSchedulerClient.runJobCallable().futureCall(request);
* // Do something.
* Job response = future.get();
* }
* }
*/
public final UnaryCallable runJobCallable() {
return stub.runJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param 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
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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 future =
* cloudSchedulerClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@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;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@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 future = cloudSchedulerClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListJobsPagedResponse
extends AbstractPagedListResponse<
ListJobsRequest, ListJobsResponse, Job, ListJobsPage, ListJobsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListJobsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListJobsPagedResponse(input), MoreExecutors.directExecutor());
}
private ListJobsPagedResponse(ListJobsPage page) {
super(page, ListJobsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListJobsPage
extends AbstractPage {
private ListJobsPage(
PageContext context, ListJobsResponse response) {
super(context, response);
}
private static ListJobsPage createEmptyPage() {
return new ListJobsPage(null, null);
}
@Override
protected ListJobsPage createPage(
PageContext context, ListJobsResponse response) {
return new ListJobsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListJobsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListJobsRequest, ListJobsResponse, Job, ListJobsPage, ListJobsFixedSizeCollection> {
private ListJobsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListJobsFixedSizeCollection createEmptyCollection() {
return new ListJobsFixedSizeCollection(null, 0);
}
@Override
protected ListJobsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListJobsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}