com.amazonaws.services.scheduler

Class AbstractAmazonScheduler

java.lang.Object

com.amazonaws.services.scheduler.AbstractAmazonScheduler

All Implemented Interfaces:

AmazonScheduler

Direct Known Subclasses:

AbstractAmazonSchedulerAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonScheduler
extends Object
implements AmazonScheduler

Abstract implementation of AmazonScheduler. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.scheduler.AmazonScheduler

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
CreateScheduleResult	createSchedule(CreateScheduleRequest request) Creates the specified schedule.
CreateScheduleGroupResult	createScheduleGroup(CreateScheduleGroupRequest request) Creates the specified schedule group.
DeleteScheduleResult	deleteSchedule(DeleteScheduleRequest request) Deletes the specified schedule.
DeleteScheduleGroupResult	deleteScheduleGroup(DeleteScheduleGroupRequest request) Deletes the specified schedule group.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetScheduleResult	getSchedule(GetScheduleRequest request) Retrieves the specified schedule.
GetScheduleGroupResult	getScheduleGroup(GetScheduleGroupRequest request) Retrieves the specified schedule group.
ListScheduleGroupsResult	listScheduleGroups(ListScheduleGroupsRequest request) Returns a paginated list of your schedule groups.
ListSchedulesResult	listSchedules(ListSchedulesRequest request) Returns a paginated list of your EventBridge Scheduler schedules.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags associated with the Scheduler resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from the specified EventBridge Scheduler schedule group.
UpdateScheduleResult	updateSchedule(UpdateScheduleRequest request) Updates the specified schedule.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createSchedule

public CreateScheduleResult createSchedule(CreateScheduleRequest request)

Description copied from interface: AmazonScheduler

Creates the specified schedule.

Specified by:

createSchedule in interface AmazonScheduler

Returns:

Result of the CreateSchedule operation returned by the service.

See Also:

AWS API Documentation

createScheduleGroup

public CreateScheduleGroupResult createScheduleGroup(CreateScheduleGroupRequest request)

Description copied from interface: AmazonScheduler

Creates the specified schedule group.

Specified by:

createScheduleGroup in interface AmazonScheduler

Returns:

Result of the CreateScheduleGroup operation returned by the service.

See Also:

AWS API Documentation

deleteSchedule

public DeleteScheduleResult deleteSchedule(DeleteScheduleRequest request)

Description copied from interface: AmazonScheduler

Deletes the specified schedule.

Specified by:

deleteSchedule in interface AmazonScheduler

Returns:

Result of the DeleteSchedule operation returned by the service.

See Also:

AWS API Documentation

deleteScheduleGroup

public DeleteScheduleGroupResult deleteScheduleGroup(DeleteScheduleGroupRequest request)

Description copied from interface: AmazonScheduler

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.

Specified by:

deleteScheduleGroup in interface AmazonScheduler

Returns:

Result of the DeleteScheduleGroup operation returned by the service.

See Also:

AWS API Documentation

getSchedule

public GetScheduleResult getSchedule(GetScheduleRequest request)

Description copied from interface: AmazonScheduler

Retrieves the specified schedule.

Specified by:

getSchedule in interface AmazonScheduler

Returns:

Result of the GetSchedule operation returned by the service.

See Also:

AWS API Documentation

getScheduleGroup

public GetScheduleGroupResult getScheduleGroup(GetScheduleGroupRequest request)

Description copied from interface: AmazonScheduler

Retrieves the specified schedule group.

Specified by:

getScheduleGroup in interface AmazonScheduler

Returns:

Result of the GetScheduleGroup operation returned by the service.

See Also:

AWS API Documentation

listScheduleGroups

public ListScheduleGroupsResult listScheduleGroups(ListScheduleGroupsRequest request)

Description copied from interface: AmazonScheduler

Returns a paginated list of your schedule groups.

Specified by:

listScheduleGroups in interface AmazonScheduler

Returns:

Result of the ListScheduleGroups operation returned by the service.

See Also:

AWS API Documentation

listSchedules

public ListSchedulesResult listSchedules(ListSchedulesRequest request)

Description copied from interface: AmazonScheduler

Returns a paginated list of your EventBridge Scheduler schedules.

Specified by:

listSchedules in interface AmazonScheduler

Returns:

Result of the ListSchedules operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonScheduler

Lists the tags associated with the Scheduler resource.

Specified by:

listTagsForResource in interface AmazonScheduler

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonScheduler

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.

Specified by:

tagResource in interface AmazonScheduler

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonScheduler

Removes one or more tags from the specified EventBridge Scheduler schedule group.

Specified by:

untagResource in interface AmazonScheduler

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateSchedule

public UpdateScheduleResult updateSchedule(UpdateScheduleRequest request)

Description copied from interface: AmazonScheduler

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.

Specified by:

updateSchedule in interface AmazonScheduler

Returns:

Result of the UpdateSchedule operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonScheduler

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonScheduler

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonScheduler

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AmazonScheduler

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.