Class ScheduleServiceClient (3.18.0)

Version 3.18.0

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class ScheduleServiceClient implements BackgroundResource

Service Description: A service for creating and managing Vertex AI's Schedule resources to periodically launch shceudled runs to make API calls.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Schedule schedule = Schedule.newBuilder().build();
   Schedule response = scheduleServiceClient.createSchedule(parent, schedule);
 }
 

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

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

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of ScheduleServiceSettings 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
 ScheduleServiceSettings scheduleServiceSettings =
     ScheduleServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ScheduleServiceClient scheduleServiceClient =
     ScheduleServiceClient.create(scheduleServiceSettings);
 

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
 ScheduleServiceSettings scheduleServiceSettings =
     ScheduleServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ScheduleServiceClient scheduleServiceClient =
     ScheduleServiceClient.create(scheduleServiceSettings);
 

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

Inheritance

java.lang.Object > ScheduleServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ScheduleServiceClient create()

Constructs an instance of ScheduleServiceClient with default settings.

Returns
Type	Description
ScheduleServiceClient

Exceptions
Type	Description
IOException

create(ScheduleServiceSettings settings)

public static final ScheduleServiceClient create(ScheduleServiceSettings settings)

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

Parameter
Name	Description
settings	ScheduleServiceSettings

Returns
Type	Description
ScheduleServiceClient

Exceptions
Type	Description
IOException

create(ScheduleServiceStub stub)

public static final ScheduleServiceClient create(ScheduleServiceStub stub)

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

Parameter
Name	Description
stub	ScheduleServiceStub

Returns
Type	Description
ScheduleServiceClient

Constructors

ScheduleServiceClient(ScheduleServiceSettings settings)

protected ScheduleServiceClient(ScheduleServiceSettings settings)

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

Parameter
Name	Description
settings	ScheduleServiceSettings

ScheduleServiceClient(ScheduleServiceStub stub)

protected ScheduleServiceClient(ScheduleServiceStub stub)

Parameter
Name	Description
stub	ScheduleServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

createSchedule(CreateScheduleRequest request)

public final Schedule createSchedule(CreateScheduleRequest request)

Creates a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   CreateScheduleRequest request =
       CreateScheduleRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSchedule(Schedule.newBuilder().build())
           .build();
   Schedule response = scheduleServiceClient.createSchedule(request);
 }
 

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

Returns
Type	Description
Schedule

createSchedule(LocationName parent, Schedule schedule)

public final Schedule createSchedule(LocationName parent, Schedule schedule)

Creates a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Schedule schedule = Schedule.newBuilder().build();
   Schedule response = scheduleServiceClient.createSchedule(parent, schedule);
 }
 

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to create the Schedule in. Format: projects/{project}/locations/{location}
schedule	Schedule Required. The Schedule to create.

Returns
Type	Description
Schedule

createSchedule(String parent, Schedule schedule)

public final Schedule createSchedule(String parent, Schedule schedule)

Creates a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Schedule schedule = Schedule.newBuilder().build();
   Schedule response = scheduleServiceClient.createSchedule(parent, schedule);
 }
 

Parameters
Name	Description
parent	String Required. The resource name of the Location to create the Schedule in. Format: projects/{project}/locations/{location}
schedule	Schedule Required. The Schedule to create.

Returns
Type	Description
Schedule

createScheduleCallable()

public final UnaryCallable<CreateScheduleRequest,Schedule> createScheduleCallable()

Creates a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   CreateScheduleRequest request =
       CreateScheduleRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSchedule(Schedule.newBuilder().build())
           .build();
   ApiFuture<Schedule> future =
       scheduleServiceClient.createScheduleCallable().futureCall(request);
   // Do something.
   Schedule response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateScheduleRequest,Schedule>

deleteScheduleAsync(DeleteScheduleRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteScheduleAsync(DeleteScheduleRequest request)

Deletes a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   DeleteScheduleRequest request =
       DeleteScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   scheduleServiceClient.deleteScheduleAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteScheduleAsync(ScheduleName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteScheduleAsync(ScheduleName name)

Deletes a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
   scheduleServiceClient.deleteScheduleAsync(name).get();
 }
 

Parameter
Name	Description
name	ScheduleName Required. The name of the Schedule resource to be deleted. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteScheduleAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteScheduleAsync(String name)

Deletes a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
   scheduleServiceClient.deleteScheduleAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. The name of the Schedule resource to be deleted. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteScheduleCallable()

public final UnaryCallable<DeleteScheduleRequest,Operation> deleteScheduleCallable()

Deletes a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   DeleteScheduleRequest request =
       DeleteScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   ApiFuture<Operation> future =
       scheduleServiceClient.deleteScheduleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteScheduleRequest,Operation>

deleteScheduleOperationCallable()

public final OperationCallable<DeleteScheduleRequest,Empty,DeleteOperationMetadata> deleteScheduleOperationCallable()

Deletes a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   DeleteScheduleRequest request =
       DeleteScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       scheduleServiceClient.deleteScheduleOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteScheduleRequest,Empty,DeleteOperationMetadata>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = scheduleServiceClient.getIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = scheduleServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = scheduleServiceClient.getLocation(request);
 }
 

Parameter
Name	Description
request	com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.cloud.location.Location

getLocationCallable()

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

Returns
Type	Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getSchedule(GetScheduleRequest request)

public final Schedule getSchedule(GetScheduleRequest request)

Gets a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   GetScheduleRequest request =
       GetScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   Schedule response = scheduleServiceClient.getSchedule(request);
 }
 

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

Returns
Type	Description
Schedule

getSchedule(ScheduleName name)

public final Schedule getSchedule(ScheduleName name)

Gets a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
   Schedule response = scheduleServiceClient.getSchedule(name);
 }
 

Parameter
Name	Description
name	ScheduleName Required. The name of the Schedule resource. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type	Description
Schedule

getSchedule(String name)

public final Schedule getSchedule(String name)

Gets a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
   Schedule response = scheduleServiceClient.getSchedule(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the Schedule resource. Format: projects/{project}/locations/{location}/schedules/{schedule}

Returns
Type	Description
Schedule

getScheduleCallable()

public final UnaryCallable<GetScheduleRequest,Schedule> getScheduleCallable()

Gets a Schedule.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   GetScheduleRequest request =
       GetScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   ApiFuture<Schedule> future = scheduleServiceClient.getScheduleCallable().futureCall(request);
   // Do something.
   Schedule response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetScheduleRequest,Schedule>

getSettings()

public final ScheduleServiceSettings getSettings()

Returns
Type	Description
ScheduleServiceSettings

getStub()

public ScheduleServiceStub getStub()

Returns
Type	Description
ScheduleServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listLocations(ListLocationsRequest request)

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

Parameter
Name	Description
request	com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ScheduleServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         scheduleServiceClient.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;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

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

Returns
Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listSchedules(ListSchedulesRequest request)

public final ScheduleServiceClient.ListSchedulesPagedResponse listSchedules(ListSchedulesRequest request)

Lists Schedules in 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ListSchedulesRequest request =
       ListSchedulesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Schedule element : scheduleServiceClient.listSchedules(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
ScheduleServiceClient.ListSchedulesPagedResponse

listSchedules(LocationName parent)

public final ScheduleServiceClient.ListSchedulesPagedResponse listSchedules(LocationName parent)

Lists Schedules in 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Schedule element : scheduleServiceClient.listSchedules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	LocationName Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

Returns
Type	Description
ScheduleServiceClient.ListSchedulesPagedResponse

listSchedules(String parent)

public final ScheduleServiceClient.ListSchedulesPagedResponse listSchedules(String parent)

Lists Schedules in 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Schedule element : scheduleServiceClient.listSchedules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

Returns
Type	Description
ScheduleServiceClient.ListSchedulesPagedResponse

listSchedulesCallable()

public final UnaryCallable<ListSchedulesRequest,ListSchedulesResponse> listSchedulesCallable()

Lists Schedules in 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ListSchedulesRequest request =
       ListSchedulesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListSchedulesResponse response =
         scheduleServiceClient.listSchedulesCallable().call(request);
     for (Schedule element : response.getSchedulesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListSchedulesRequest,ListSchedulesResponse>

listSchedulesPagedCallable()

public final UnaryCallable<ListSchedulesRequest,ScheduleServiceClient.ListSchedulesPagedResponse> listSchedulesPagedCallable()

Lists Schedules in 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ListSchedulesRequest request =
       ListSchedulesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Schedule> future =
       scheduleServiceClient.listSchedulesPagedCallable().futureCall(request);
   // Do something.
   for (Schedule element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListSchedulesRequest,ListSchedulesPagedResponse>

pauseSchedule(PauseScheduleRequest request)

public final void pauseSchedule(PauseScheduleRequest request)

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   PauseScheduleRequest request =
       PauseScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   scheduleServiceClient.pauseSchedule(request);
 }
 

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

pauseSchedule(ScheduleName name)

public final void pauseSchedule(ScheduleName name)

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
   scheduleServiceClient.pauseSchedule(name);
 }
 

Parameter
Name	Description
name	ScheduleName Required. The name of the Schedule resource to be paused. Format: projects/{project}/locations/{location}/schedules/{schedule}

pauseSchedule(String name)

public final void pauseSchedule(String name)

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
   scheduleServiceClient.pauseSchedule(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the Schedule resource to be paused. Format: projects/{project}/locations/{location}/schedules/{schedule}

pauseScheduleCallable()

public final UnaryCallable<PauseScheduleRequest,Empty> pauseScheduleCallable()

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   PauseScheduleRequest request =
       PauseScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .build();
   ApiFuture<Empty> future = scheduleServiceClient.pauseScheduleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<PauseScheduleRequest,Empty>

resumeSchedule(ResumeScheduleRequest request)

public final void resumeSchedule(ResumeScheduleRequest request)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ResumeScheduleRequest request =
       ResumeScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .setCatchUp(true)
           .build();
   scheduleServiceClient.resumeSchedule(request);
 }
 

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

resumeSchedule(ScheduleName name)

public final void resumeSchedule(ScheduleName name)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
   scheduleServiceClient.resumeSchedule(name);
 }
 

Parameter
Name	Description
name	ScheduleName Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}

resumeSchedule(ScheduleName name, boolean catchUp)

public final void resumeSchedule(ScheduleName name, boolean catchUp)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
   boolean catchUp = true;
   scheduleServiceClient.resumeSchedule(name, catchUp);
 }
 

Parameters
Name	Description
name	ScheduleName Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}
catchUp	boolean Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false.

resumeSchedule(String name)

public final void resumeSchedule(String name)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
   scheduleServiceClient.resumeSchedule(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}

resumeSchedule(String name, boolean catchUp)

public final void resumeSchedule(String name, boolean catchUp)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
   boolean catchUp = true;
   scheduleServiceClient.resumeSchedule(name, catchUp);
 }
 

Parameters
Name	Description
name	String Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}
catchUp	boolean Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false.

resumeScheduleCallable()

public final UnaryCallable<ResumeScheduleRequest,Empty> resumeScheduleCallable()

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   ResumeScheduleRequest request =
       ResumeScheduleRequest.newBuilder()
           .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
           .setCatchUp(true)
           .build();
   ApiFuture<Empty> future = scheduleServiceClient.resumeScheduleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<ResumeScheduleRequest,Empty>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = scheduleServiceClient.setIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = scheduleServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = scheduleServiceClient.testIamPermissions(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       scheduleServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>