/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.scheduler; import javax.annotation.Generated; import com.amazonaws.services.scheduler.model.*; /** * Interface for accessing Amazon EventBridge Scheduler asynchronously. Each asynchronous method will return a Java * Future object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to * receive notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.scheduler.AbstractAmazonSchedulerAsync} instead. *
**
* Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one * central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust * your schedules based on the availability of downstream targets. The following reference lists the available API * actions, and data types for EventBridge Scheduler. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSchedulerAsync extends AmazonScheduler { /** ** Creates the specified schedule. *
* * @param createScheduleRequest * @return A Java Future containing the result of the CreateSchedule operation returned by the service. * @sample AmazonSchedulerAsync.CreateSchedule * @see AWS API * Documentation */ java.util.concurrent.Future* Creates the specified schedule. *
* * @param createScheduleRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateSchedule operation returned by the service. * @sample AmazonSchedulerAsyncHandler.CreateSchedule * @see AWS API * Documentation */ java.util.concurrent.Future* Creates the specified schedule group. *
* * @param createScheduleGroupRequest * @return A Java Future containing the result of the CreateScheduleGroup operation returned by the service. * @sample AmazonSchedulerAsync.CreateScheduleGroup * @see AWS * API Documentation */ java.util.concurrent.Future* Creates the specified schedule group. *
* * @param createScheduleGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateScheduleGroup operation returned by the service. * @sample AmazonSchedulerAsyncHandler.CreateScheduleGroup * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes the specified schedule. *
* * @param deleteScheduleRequest * @return A Java Future containing the result of the DeleteSchedule operation returned by the service. * @sample AmazonSchedulerAsync.DeleteSchedule * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified schedule. *
* * @param deleteScheduleRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteSchedule operation returned by the service. * @sample AmazonSchedulerAsyncHandler.DeleteSchedule * @see AWS API * Documentation */ java.util.concurrent.Future
* Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all
* schedules associated with the group. When you delete a group, it remains in a DELETING
state until
* all of its associated schedules are deleted. Schedules associated with the group that are set to run while the
* schedule group is in the process of being deleted might continue to invoke their targets until the schedule group
* and its associated schedules are deleted.
*
* This operation is eventually consistent. *
*
* Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all
* schedules associated with the group. When you delete a group, it remains in a DELETING
state until
* all of its associated schedules are deleted. Schedules associated with the group that are set to run while the
* schedule group is in the process of being deleted might continue to invoke their targets until the schedule group
* and its associated schedules are deleted.
*
* This operation is eventually consistent. *
** Retrieves the specified schedule. *
* * @param getScheduleRequest * @return A Java Future containing the result of the GetSchedule operation returned by the service. * @sample AmazonSchedulerAsync.GetSchedule * @see AWS API * Documentation */ java.util.concurrent.Future* Retrieves the specified schedule. *
* * @param getScheduleRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetSchedule operation returned by the service. * @sample AmazonSchedulerAsyncHandler.GetSchedule * @see AWS API * Documentation */ java.util.concurrent.Future* Retrieves the specified schedule group. *
* * @param getScheduleGroupRequest * @return A Java Future containing the result of the GetScheduleGroup operation returned by the service. * @sample AmazonSchedulerAsync.GetScheduleGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Retrieves the specified schedule group. *
* * @param getScheduleGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetScheduleGroup operation returned by the service. * @sample AmazonSchedulerAsyncHandler.GetScheduleGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Returns a paginated list of your schedule groups. *
* * @param listScheduleGroupsRequest * @return A Java Future containing the result of the ListScheduleGroups operation returned by the service. * @sample AmazonSchedulerAsync.ListScheduleGroups * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a paginated list of your schedule groups. *
* * @param listScheduleGroupsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListScheduleGroups operation returned by the service. * @sample AmazonSchedulerAsyncHandler.ListScheduleGroups * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a paginated list of your EventBridge Scheduler schedules. *
* * @param listSchedulesRequest * @return A Java Future containing the result of the ListSchedules operation returned by the service. * @sample AmazonSchedulerAsync.ListSchedules * @see AWS API * Documentation */ java.util.concurrent.Future* Returns a paginated list of your EventBridge Scheduler schedules. *
* * @param listSchedulesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSchedules operation returned by the service. * @sample AmazonSchedulerAsyncHandler.ListSchedules * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the tags associated with the Scheduler resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonSchedulerAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the tags associated with the Scheduler resource. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonSchedulerAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign * tags to schedule groups. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonSchedulerAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign * tags to schedule groups. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonSchedulerAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes one or more tags from the specified EventBridge Scheduler schedule group. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonSchedulerAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes one or more tags from the specified EventBridge Scheduler schedule group. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonSchedulerAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future
* Updates the specified schedule. When you call UpdateSchedule
, EventBridge Scheduler uses all values,
* including empty values, specified in the request and overrides the existing schedule. This is by design. This
* means that if you do not set an optional field in your request, that field will be set to its system-default
* value after the update.
*
* Before calling this operation, we recommend that you call the GetSchedule
API operation and make a
* note of all optional parameters for your UpdateSchedule
call.
*
* Updates the specified schedule. When you call UpdateSchedule
, EventBridge Scheduler uses all values,
* including empty values, specified in the request and overrides the existing schedule. This is by design. This
* means that if you do not set an optional field in your request, that field will be set to its system-default
* value after the update.
*
* Before calling this operation, we recommend that you call the GetSchedule
API operation and make a
* note of all optional parameters for your UpdateSchedule
call.
*