@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SchedulerAsyncClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SchedulerAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SchedulerAsyncClient. |
static SchedulerAsyncClient |
create()
Create a
SchedulerAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateScheduleResponse> |
createSchedule(Consumer<CreateScheduleRequest.Builder> createScheduleRequest)
Creates the specified schedule.
|
default CompletableFuture<CreateScheduleResponse> |
createSchedule(CreateScheduleRequest createScheduleRequest)
Creates the specified schedule.
|
default CompletableFuture<CreateScheduleGroupResponse> |
createScheduleGroup(Consumer<CreateScheduleGroupRequest.Builder> createScheduleGroupRequest)
Creates the specified schedule group.
|
default CompletableFuture<CreateScheduleGroupResponse> |
createScheduleGroup(CreateScheduleGroupRequest createScheduleGroupRequest)
Creates the specified schedule group.
|
default CompletableFuture<DeleteScheduleResponse> |
deleteSchedule(Consumer<DeleteScheduleRequest.Builder> deleteScheduleRequest)
Deletes the specified schedule.
|
default CompletableFuture<DeleteScheduleResponse> |
deleteSchedule(DeleteScheduleRequest deleteScheduleRequest)
Deletes the specified schedule.
|
default CompletableFuture<DeleteScheduleGroupResponse> |
deleteScheduleGroup(Consumer<DeleteScheduleGroupRequest.Builder> deleteScheduleGroupRequest)
Deletes the specified schedule group.
|
default CompletableFuture<DeleteScheduleGroupResponse> |
deleteScheduleGroup(DeleteScheduleGroupRequest deleteScheduleGroupRequest)
Deletes the specified schedule group.
|
default CompletableFuture<GetScheduleResponse> |
getSchedule(Consumer<GetScheduleRequest.Builder> getScheduleRequest)
Retrieves the specified schedule.
|
default CompletableFuture<GetScheduleResponse> |
getSchedule(GetScheduleRequest getScheduleRequest)
Retrieves the specified schedule.
|
default CompletableFuture<GetScheduleGroupResponse> |
getScheduleGroup(Consumer<GetScheduleGroupRequest.Builder> getScheduleGroupRequest)
Retrieves the specified schedule group.
|
default CompletableFuture<GetScheduleGroupResponse> |
getScheduleGroup(GetScheduleGroupRequest getScheduleGroupRequest)
Retrieves the specified schedule group.
|
default CompletableFuture<ListScheduleGroupsResponse> |
listScheduleGroups(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
|
default CompletableFuture<ListScheduleGroupsResponse> |
listScheduleGroups(ListScheduleGroupsRequest listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
|
default ListScheduleGroupsPublisher |
listScheduleGroupsPaginator(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
|
default ListScheduleGroupsPublisher |
listScheduleGroupsPaginator(ListScheduleGroupsRequest listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
|
default CompletableFuture<ListSchedulesResponse> |
listSchedules(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
|
default CompletableFuture<ListSchedulesResponse> |
listSchedules(ListSchedulesRequest listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
|
default ListSchedulesPublisher |
listSchedulesPaginator(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
|
default ListSchedulesPublisher |
listSchedulesPaginator(ListSchedulesRequest listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with the Scheduler resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with the Scheduler resource.
|
default SchedulerServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
|
default CompletableFuture<UpdateScheduleResponse> |
updateSchedule(Consumer<UpdateScheduleRequest.Builder> updateScheduleRequest)
Updates the specified schedule.
|
default CompletableFuture<UpdateScheduleResponse> |
updateSchedule(UpdateScheduleRequest updateScheduleRequest)
Updates the specified schedule.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateScheduleResponse> createSchedule(CreateScheduleRequest createScheduleRequest)
Creates the specified schedule.
createScheduleRequest - default CompletableFuture<CreateScheduleResponse> createSchedule(Consumer<CreateScheduleRequest.Builder> createScheduleRequest)
Creates the specified schedule.
This is a convenience which creates an instance of the CreateScheduleRequest.Builder avoiding the need to
create one manually via CreateScheduleRequest.builder()
createScheduleRequest - A Consumer that will call methods on CreateScheduleInput.Builder to create a request.default CompletableFuture<CreateScheduleGroupResponse> createScheduleGroup(CreateScheduleGroupRequest createScheduleGroupRequest)
Creates the specified schedule group.
createScheduleGroupRequest - default CompletableFuture<CreateScheduleGroupResponse> createScheduleGroup(Consumer<CreateScheduleGroupRequest.Builder> createScheduleGroupRequest)
Creates the specified schedule group.
This is a convenience which creates an instance of the CreateScheduleGroupRequest.Builder avoiding the
need to create one manually via CreateScheduleGroupRequest.builder()
createScheduleGroupRequest - A Consumer that will call methods on CreateScheduleGroupInput.Builder to create a request.default CompletableFuture<DeleteScheduleResponse> deleteSchedule(DeleteScheduleRequest deleteScheduleRequest)
Deletes the specified schedule.
deleteScheduleRequest - default CompletableFuture<DeleteScheduleResponse> deleteSchedule(Consumer<DeleteScheduleRequest.Builder> deleteScheduleRequest)
Deletes the specified schedule.
This is a convenience which creates an instance of the DeleteScheduleRequest.Builder avoiding the need to
create one manually via DeleteScheduleRequest.builder()
deleteScheduleRequest - A Consumer that will call methods on DeleteScheduleInput.Builder to create a request.default CompletableFuture<DeleteScheduleGroupResponse> deleteScheduleGroup(DeleteScheduleGroupRequest deleteScheduleGroupRequest)
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.
deleteScheduleGroupRequest - default CompletableFuture<DeleteScheduleGroupResponse> deleteScheduleGroup(Consumer<DeleteScheduleGroupRequest.Builder> deleteScheduleGroupRequest)
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.
This is a convenience which creates an instance of the DeleteScheduleGroupRequest.Builder avoiding the
need to create one manually via DeleteScheduleGroupRequest.builder()
deleteScheduleGroupRequest - A Consumer that will call methods on DeleteScheduleGroupInput.Builder to create a request.default CompletableFuture<GetScheduleResponse> getSchedule(GetScheduleRequest getScheduleRequest)
Retrieves the specified schedule.
getScheduleRequest - default CompletableFuture<GetScheduleResponse> getSchedule(Consumer<GetScheduleRequest.Builder> getScheduleRequest)
Retrieves the specified schedule.
This is a convenience which creates an instance of the GetScheduleRequest.Builder avoiding the need to
create one manually via GetScheduleRequest.builder()
getScheduleRequest - A Consumer that will call methods on GetScheduleInput.Builder to create a request.default CompletableFuture<GetScheduleGroupResponse> getScheduleGroup(GetScheduleGroupRequest getScheduleGroupRequest)
Retrieves the specified schedule group.
getScheduleGroupRequest - default CompletableFuture<GetScheduleGroupResponse> getScheduleGroup(Consumer<GetScheduleGroupRequest.Builder> getScheduleGroupRequest)
Retrieves the specified schedule group.
This is a convenience which creates an instance of the GetScheduleGroupRequest.Builder avoiding the need
to create one manually via GetScheduleGroupRequest.builder()
getScheduleGroupRequest - A Consumer that will call methods on GetScheduleGroupInput.Builder to create a request.default CompletableFuture<ListScheduleGroupsResponse> listScheduleGroups(ListScheduleGroupsRequest listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
listScheduleGroupsRequest - default CompletableFuture<ListScheduleGroupsResponse> listScheduleGroups(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
This is a convenience which creates an instance of the ListScheduleGroupsRequest.Builder avoiding the
need to create one manually via ListScheduleGroupsRequest.builder()
listScheduleGroupsRequest - A Consumer that will call methods on ListScheduleGroupsInput.Builder to create a request.default ListScheduleGroupsPublisher listScheduleGroupsPaginator(ListScheduleGroupsRequest listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
This is a variant of
listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest)
operation.
listScheduleGroupsRequest - default ListScheduleGroupsPublisher listScheduleGroupsPaginator(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
This is a variant of
listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest)
operation.
This is a convenience which creates an instance of the ListScheduleGroupsRequest.Builder avoiding the
need to create one manually via ListScheduleGroupsRequest.builder()
listScheduleGroupsRequest - A Consumer that will call methods on ListScheduleGroupsInput.Builder to create a request.default CompletableFuture<ListSchedulesResponse> listSchedules(ListSchedulesRequest listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
listSchedulesRequest - default CompletableFuture<ListSchedulesResponse> listSchedules(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
This is a convenience which creates an instance of the ListSchedulesRequest.Builder avoiding the need to
create one manually via ListSchedulesRequest.builder()
listSchedulesRequest - A Consumer that will call methods on ListSchedulesInput.Builder to create a request.default ListSchedulesPublisher listSchedulesPaginator(ListSchedulesRequest listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
This is a variant of listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest) operation.
listSchedulesRequest - default ListSchedulesPublisher listSchedulesPaginator(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
This is a variant of listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest) operation.
This is a convenience which creates an instance of the ListSchedulesRequest.Builder avoiding the need to
create one manually via ListSchedulesRequest.builder()
listSchedulesRequest - A Consumer that will call methods on ListSchedulesInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with the Scheduler resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with the Scheduler resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.default CompletableFuture<UpdateScheduleResponse> updateSchedule(UpdateScheduleRequest updateScheduleRequest)
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.
updateScheduleRequest - default CompletableFuture<UpdateScheduleResponse> updateSchedule(Consumer<UpdateScheduleRequest.Builder> updateScheduleRequest)
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.
This is a convenience which creates an instance of the UpdateScheduleRequest.Builder avoiding the need to
create one manually via UpdateScheduleRequest.builder()
updateScheduleRequest - A Consumer that will call methods on UpdateScheduleInput.Builder to create a request.default SchedulerServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic SchedulerAsyncClient create()
SchedulerAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SchedulerAsyncClientBuilder builder()
SchedulerAsyncClient.Copyright © 2023. All rights reserved.