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 (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * StreamingPredictRequest request =
+ * StreamingPredictRequest.newBuilder()
+ * .setEndpoint(
+ * EndpointName.ofProjectLocationEndpointName(
+ * "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
+ * .toString())
+ * .addAllInputs(new ArrayList())
+ * .setParameters(Tensor.newBuilder().build())
+ * .build();
+ * ServerStream stream =
+ * predictionServiceClient.serverStreamingPredictCallable().call(request);
+ * for (StreamingPredictResponse response : stream) {
+ * // Do something when a response is received.
+ * }
+ * }
+ * }
+ */
+ public final ServerStreamingCallableThis 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 (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: + * + *
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: + * + *
{@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
+ * ScheduleServiceSettings scheduleServiceSettings =
+ * ScheduleServiceSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * ScheduleServiceClient scheduleServiceClient =
+ * ScheduleServiceClient.create(scheduleServiceSettings);
+ * }
+ *
+ * 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
+ * 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. + */ +@Generated("by gapic-generator-java") +public class ScheduleServiceClient implements BackgroundResource { + private final ScheduleServiceSettings settings; + private final ScheduleServiceStub stub; + private final OperationsClient operationsClient; + + /** Constructs an instance of ScheduleServiceClient with default settings. */ + public static final ScheduleServiceClient create() throws IOException { + return create(ScheduleServiceSettings.newBuilder().build()); + } + + /** + * 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. + */ + public static final ScheduleServiceClient create(ScheduleServiceSettings settings) + throws IOException { + return new ScheduleServiceClient(settings); + } + + /** + * Constructs an instance of ScheduleServiceClient, using the given stub for making calls. This is + * for advanced usage - prefer using create(ScheduleServiceSettings). + */ + public static final ScheduleServiceClient create(ScheduleServiceStub stub) { + return new ScheduleServiceClient(stub); + } + + /** + * 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. + */ + protected ScheduleServiceClient(ScheduleServiceSettings settings) throws IOException { + this.settings = settings; + this.stub = ((ScheduleServiceStubSettings) settings.getStubSettings()).createStub(); + this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); + } + + protected ScheduleServiceClient(ScheduleServiceStub stub) { + this.settings = null; + this.stub = stub; + this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); + } + + public final ScheduleServiceSettings getSettings() { + return settings; + } + + public ScheduleServiceStub getStub() { + return stub; + } + + /** + * Returns the OperationsClient that can be used to query the status of a long-running operation + * returned by another API method call. + */ + public final OperationsClient getOperationsClient() { + return operationsClient; + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Creates a Schedule. + * + *
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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * Schedule schedule = Schedule.newBuilder().build();
+ * Schedule response = scheduleServiceClient.createSchedule(parent, schedule);
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the Location to create the Schedule in. Format:
+ * `projects/{project}/locations/{location}`
+ * @param schedule Required. The Schedule to create.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Schedule createSchedule(LocationName parent, Schedule schedule) {
+ CreateScheduleRequest request =
+ CreateScheduleRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .setSchedule(schedule)
+ .build();
+ return createSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a Schedule.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
+ * Schedule schedule = Schedule.newBuilder().build();
+ * Schedule response = scheduleServiceClient.createSchedule(parent, schedule);
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the Location to create the Schedule in. Format:
+ * `projects/{project}/locations/{location}`
+ * @param schedule Required. The Schedule to create.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Schedule createSchedule(String parent, Schedule schedule) {
+ CreateScheduleRequest request =
+ CreateScheduleRequest.newBuilder().setParent(parent).setSchedule(schedule).build();
+ return createSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a Schedule.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * CreateScheduleRequest request =
+ * CreateScheduleRequest.newBuilder()
+ * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
+ * .setSchedule(Schedule.newBuilder().build())
+ * .build();
+ * Schedule response = scheduleServiceClient.createSchedule(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 Schedule createSchedule(CreateScheduleRequest request) {
+ return createScheduleCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a Schedule.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * CreateScheduleRequest request =
+ * CreateScheduleRequest.newBuilder()
+ * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
+ * .setSchedule(Schedule.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * scheduleServiceClient.createScheduleCallable().futureCall(request);
+ * // Do something.
+ * Schedule response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
+ * scheduleServiceClient.deleteScheduleAsync(name).get();
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be deleted. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final OperationFutureSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
+ * scheduleServiceClient.deleteScheduleAsync(name).get();
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be deleted. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final OperationFutureSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * DeleteScheduleRequest request =
+ * DeleteScheduleRequest.newBuilder()
+ * .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
+ * .build();
+ * scheduleServiceClient.deleteScheduleAsync(request).get();
+ * }
+ * }
+ *
+ * @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 OperationFutureSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * DeleteScheduleRequest request =
+ * DeleteScheduleRequest.newBuilder()
+ * .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
+ * .build();
+ * OperationFuture future =
+ * scheduleServiceClient.deleteScheduleOperationCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
+ */
+ public final OperationCallableSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * DeleteScheduleRequest request =
+ * DeleteScheduleRequest.newBuilder()
+ * .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
+ * .build();
+ * ApiFuture future =
+ * scheduleServiceClient.deleteScheduleCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
+ * Schedule response = scheduleServiceClient.getSchedule(name);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Schedule getSchedule(ScheduleName name) {
+ GetScheduleRequest request =
+ GetScheduleRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ return getSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets a Schedule.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * String name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString();
+ * Schedule response = scheduleServiceClient.getSchedule(name);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Schedule getSchedule(String name) {
+ GetScheduleRequest request = GetScheduleRequest.newBuilder().setName(name).build();
+ return getSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets a Schedule.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * GetScheduleRequest request =
+ * GetScheduleRequest.newBuilder()
+ * .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
+ * .build();
+ * Schedule response = scheduleServiceClient.getSchedule(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 Schedule getSchedule(GetScheduleRequest request) {
+ return getScheduleCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets a Schedule.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * GetScheduleRequest request =
+ * GetScheduleRequest.newBuilder()
+ * .setName(ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]").toString())
+ * .build();
+ * ApiFuture future = scheduleServiceClient.getScheduleCallable().futureCall(request);
+ * // Do something.
+ * Schedule response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * for (Schedule element : scheduleServiceClient.listSchedules(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the Location to list the Schedules from. Format:
+ * `projects/{project}/locations/{location}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSchedulesPagedResponse listSchedules(LocationName parent) {
+ ListSchedulesRequest request =
+ ListSchedulesRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .build();
+ return listSchedules(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists Schedules in 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
+ * for (Schedule element : scheduleServiceClient.listSchedules(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the Location to list the Schedules from. Format:
+ * `projects/{project}/locations/{location}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSchedulesPagedResponse listSchedules(String parent) {
+ ListSchedulesRequest request = ListSchedulesRequest.newBuilder().setParent(parent).build();
+ return listSchedules(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists Schedules in 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 (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);
+ * }
+ * }
+ * }
+ *
+ * @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 ListSchedulesPagedResponse listSchedules(ListSchedulesRequest request) {
+ return listSchedulesPagedCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists Schedules in 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 (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 future =
+ * scheduleServiceClient.listSchedulesPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Schedule element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (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;
+ * }
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * ScheduleName name = ScheduleName.of("[PROJECT]", "[LOCATION]", "[SCHEDULE]");
+ * scheduleServiceClient.pauseSchedule(name);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be paused. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void pauseSchedule(ScheduleName name) {
+ PauseScheduleRequest request =
+ PauseScheduleRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ pauseSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be paused. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void pauseSchedule(String name) {
+ PauseScheduleRequest request = PauseScheduleRequest.newBuilder().setName(name).build();
+ pauseSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @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 pauseSchedule(PauseScheduleRequest request) {
+ pauseScheduleCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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 future = scheduleServiceClient.pauseScheduleCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableWhen 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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be resumed. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void resumeSchedule(ScheduleName name) {
+ ResumeScheduleRequest request =
+ ResumeScheduleRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ resumeSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Resumes a paused Schedule to start scheduling new runs. Will mark
+ * [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be resumed. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void resumeSchedule(String name) {
+ ResumeScheduleRequest request = ResumeScheduleRequest.newBuilder().setName(name).build();
+ resumeSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Resumes a paused Schedule to start scheduling new runs. Will mark
+ * [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be resumed. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @param catchUp 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][google.cloud.aiplatform.v1.Schedule.catch_up] field. Default to false.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void resumeSchedule(ScheduleName name, boolean catchUp) {
+ ResumeScheduleRequest request =
+ ResumeScheduleRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .setCatchUp(catchUp)
+ .build();
+ resumeSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Resumes a paused Schedule to start scheduling new runs. Will mark
+ * [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @param name Required. The name of the Schedule resource to be resumed. Format:
+ * `projects/{project}/locations/{location}/schedules/{schedule}`
+ * @param catchUp 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][google.cloud.aiplatform.v1.Schedule.catch_up] field. Default to false.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void resumeSchedule(String name, boolean catchUp) {
+ ResumeScheduleRequest request =
+ ResumeScheduleRequest.newBuilder().setName(name).setCatchUp(catchUp).build();
+ resumeSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Resumes a paused Schedule to start scheduling new runs. Will mark
+ * [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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);
+ * }
+ * }
+ *
+ * @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 resumeSchedule(ResumeScheduleRequest request) {
+ resumeScheduleCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Resumes a paused Schedule to start scheduling new runs. Will mark
+ * [Schedule.state][google.cloud.aiplatform.v1.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: + * + *
{@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 future = scheduleServiceClient.resumeScheduleCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableWhen the Schedule is updated, new runs will be scheduled starting from the updated next + * execution time after the update time based on the time_specification in the updated Schedule. + * All unstarted runs before the update time will be skipped while already created runs will NOT + * be paused or canceled. + * + *
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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * Schedule schedule = Schedule.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * Schedule response = scheduleServiceClient.updateSchedule(schedule, updateMask);
+ * }
+ * }
+ *
+ * @param schedule Required. The Schedule which replaces the resource on the server. The following
+ * restrictions will be applied: * The scheduled request type cannot be changed. * The
+ * output_only fields will be ignored if specified.
+ * @param updateMask Required. The update mask applies to the resource. See
+ * [google.protobuf.FieldMask][google.protobuf.FieldMask].
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Schedule updateSchedule(Schedule schedule, FieldMask updateMask) {
+ UpdateScheduleRequest request =
+ UpdateScheduleRequest.newBuilder().setSchedule(schedule).setUpdateMask(updateMask).build();
+ return updateSchedule(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Updates an active or paused Schedule.
+ *
+ * When the Schedule is updated, new runs will be scheduled starting from the updated next + * execution time after the update time based on the time_specification in the updated Schedule. + * All unstarted runs before the update time will be skipped while already created runs will NOT + * be paused or canceled. + * + *
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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * UpdateScheduleRequest request =
+ * UpdateScheduleRequest.newBuilder()
+ * .setSchedule(Schedule.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * Schedule response = scheduleServiceClient.updateSchedule(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 Schedule updateSchedule(UpdateScheduleRequest request) {
+ return updateScheduleCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Updates an active or paused Schedule.
+ *
+ * When the Schedule is updated, new runs will be scheduled starting from the updated next + * execution time after the update time based on the time_specification in the updated Schedule. + * All unstarted runs before the update time will be skipped while already created runs will NOT + * be paused or canceled. + * + *
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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * UpdateScheduleRequest request =
+ * UpdateScheduleRequest.newBuilder()
+ * .setSchedule(Schedule.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * scheduleServiceClient.updateScheduleCallable().futureCall(request);
+ * // Do something.
+ * Schedule response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (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);
+ * }
+ * }
+ * }
+ *
+ * @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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * ListLocationsRequest request =
+ * ListLocationsRequest.newBuilder()
+ * .setName("name3373707")
+ * .setFilter("filter-1274492040")
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * scheduleServiceClient.listLocationsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Location element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (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;
+ * }
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
+ * Location response = scheduleServiceClient.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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
+ * ApiFuture future = scheduleServiceClient.getLocationCallable().futureCall(request);
+ * // Do something.
+ * Location response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. + * + *
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 (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);
+ * }
+ * }
+ *
+ * @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 Policy setIamPolicy(SetIamPolicyRequest request) {
+ return setIamPolicyCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Sets the access control policy on the specified resource. Replacesany existing policy.
+ *
+ * Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. + * + *
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 (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 future = scheduleServiceClient.setIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample 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 (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);
+ * }
+ * }
+ *
+ * @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 Policy getIamPolicy(GetIamPolicyRequest request) {
+ return getIamPolicyCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets the access control policy for a resource. Returns an empty policyif the resource exists
+ * and does not have a policy set.
+ *
+ * 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 (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(
+ * EndpointName.ofProjectLocationEndpointName(
+ * "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
+ * .toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future = scheduleServiceClient.getIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableNote: 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: + * + *
{@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())
+ * .build();
+ * TestIamPermissionsResponse response = scheduleServiceClient.testIamPermissions(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 TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
+ return testIamPermissionsCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * 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: + * + *
{@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())
+ * .build();
+ * ApiFuture future =
+ * scheduleServiceClient.testIamPermissionsCallable().futureCall(request);
+ * // Do something.
+ * TestIamPermissionsResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableThe default instance has everything set to sensible defaults: + * + *
The builder of this class is recursive, so contained classes are themselves builders. When + * build() is called, the tree of builders is called to create the complete settings object. + * + *
For example, to set the total timeout of createSchedule to 30 seconds: + * + *
{@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
+ * ScheduleServiceSettings.Builder scheduleServiceSettingsBuilder =
+ * ScheduleServiceSettings.newBuilder();
+ * scheduleServiceSettingsBuilder
+ * .createScheduleSettings()
+ * .setRetrySettings(
+ * scheduleServiceSettingsBuilder
+ * .createScheduleSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * ScheduleServiceSettings scheduleServiceSettings = scheduleServiceSettingsBuilder.build();
+ * }
+ */
+@Generated("by gapic-generator-java")
+public class ScheduleServiceSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction ======================= ScheduleServiceClient =======================
+ *
+ * Service Description: A service for creating and managing Vertex AI's Schedule resources to
+ * periodically launch shceudled runs to make API calls.
+ *
+ * Sample for ScheduleServiceClient:
+ *
+ * ======================= SpecialistPoolServiceClient =======================
*
* Service Description: A service for creating and managing Customer SpecialistPools. When
diff --git a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/GrpcPredictionServiceStub.java b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/GrpcPredictionServiceStub.java
index 43d8265ce400..461ffd2f68db 100644
--- a/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/GrpcPredictionServiceStub.java
+++ b/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1/stub/GrpcPredictionServiceStub.java
@@ -25,12 +25,15 @@
import com.google.api.gax.grpc.GrpcStubCallableFactory;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.RequestParamsBuilder;
+import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.aiplatform.v1.ExplainRequest;
import com.google.cloud.aiplatform.v1.ExplainResponse;
import com.google.cloud.aiplatform.v1.PredictRequest;
import com.google.cloud.aiplatform.v1.PredictResponse;
import com.google.cloud.aiplatform.v1.RawPredictRequest;
+import com.google.cloud.aiplatform.v1.StreamingPredictRequest;
+import com.google.cloud.aiplatform.v1.StreamingPredictResponse;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
@@ -71,6 +74,18 @@ public class GrpcPredictionServiceStub extends PredictionServiceStub {
.setResponseMarshaller(ProtoUtils.marshaller(HttpBody.getDefaultInstance()))
.build();
+ private static final MethodDescriptor This class is for advanced usage.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcScheduleServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcScheduleServiceStub extends ScheduleServiceStub {
+ private static final MethodDescriptor This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public abstract class ScheduleServiceStub implements BackgroundResource {
+
+ public OperationsStub getOperationsStub() {
+ throw new UnsupportedOperationException("Not implemented: getOperationsStub()");
+ }
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of createSchedule to 30 seconds:
+ *
+ * {@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);
+ * }
+ * }
+ *
*
+ *
+ *
+ * {@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
+ * ScheduleServiceStubSettings.Builder scheduleServiceSettingsBuilder =
+ * ScheduleServiceStubSettings.newBuilder();
+ * scheduleServiceSettingsBuilder
+ * .createScheduleSettings()
+ * .setRetrySettings(
+ * scheduleServiceSettingsBuilder
+ * .createScheduleSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * ScheduleServiceStubSettings scheduleServiceSettings = scheduleServiceSettingsBuilder.build();
+ * }
+ */
+@Generated("by gapic-generator-java")
+public class ScheduleServiceStubSettings extends StubSettings