com.oracle.bmc.osmanagementhub

Interface ScheduledJobAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ScheduledJobAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface ScheduledJobAsync
extends AutoCloseable

Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.

Method Summary

Modifier and Type	Method and Description
Future<ChangeScheduledJobCompartmentResponse>	changeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request, AsyncHandler<ChangeScheduledJobCompartmentRequest,ChangeScheduledJobCompartmentResponse> handler) Moves a scheduled job to another compartment.
Future<CreateScheduledJobResponse>	createScheduledJob(CreateScheduledJobRequest request, AsyncHandler<CreateScheduledJobRequest,CreateScheduledJobResponse> handler) Creates a new scheduled job.
Future<DeleteScheduledJobResponse>	deleteScheduledJob(DeleteScheduledJobRequest request, AsyncHandler<DeleteScheduledJobRequest,DeleteScheduledJobResponse> handler) Deletes the specified scheduled job.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetScheduledJobResponse>	getScheduledJob(GetScheduledJobRequest request, AsyncHandler<GetScheduledJobRequest,GetScheduledJobResponse> handler) Gets information about the specified scheduled job.
Future<ListScheduledJobsResponse>	listScheduledJobs(ListScheduledJobsRequest request, AsyncHandler<ListScheduledJobsRequest,ListScheduledJobsResponse> handler) Lists scheduled jobs that match the specified compartment or scheduled job OCID.
void	refreshClient() Rebuilds the client from scratch.
Future<RunScheduledJobNowResponse>	runScheduledJobNow(RunScheduledJobNowRequest request, AsyncHandler<RunScheduledJobNowRequest,RunScheduledJobNowResponse> handler) Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly scheduled time.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateScheduledJobResponse>	updateScheduledJob(UpdateScheduledJobRequest request, AsyncHandler<UpdateScheduledJobRequest,UpdateScheduledJobResponse> handler) Updates the specified scheduled job’s name, description, and other details, such as next execution and recurrence.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

changeScheduledJobCompartment

Future<ChangeScheduledJobCompartmentResponse> changeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request,
                                                                            AsyncHandler<ChangeScheduledJobCompartmentRequest,ChangeScheduledJobCompartmentResponse> handler)

Moves a scheduled job to another compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createScheduledJob

Future<CreateScheduledJobResponse> createScheduledJob(CreateScheduledJobRequest request,
                                                      AsyncHandler<CreateScheduledJobRequest,CreateScheduledJobResponse> handler)

Creates a new scheduled job.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteScheduledJob

Future<DeleteScheduledJobResponse> deleteScheduledJob(DeleteScheduledJobRequest request,
                                                      AsyncHandler<DeleteScheduledJobRequest,DeleteScheduledJobResponse> handler)

Deletes the specified scheduled job.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getScheduledJob

Future<GetScheduledJobResponse> getScheduledJob(GetScheduledJobRequest request,
                                                AsyncHandler<GetScheduledJobRequest,GetScheduledJobResponse> handler)

Gets information about the specified scheduled job.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listScheduledJobs

Future<ListScheduledJobsResponse> listScheduledJobs(ListScheduledJobsRequest request,
                                                    AsyncHandler<ListScheduledJobsRequest,ListScheduledJobsResponse> handler)

Lists scheduled jobs that match the specified compartment or scheduled job OCID.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

runScheduledJobNow

Future<RunScheduledJobNowResponse> runScheduledJobNow(RunScheduledJobNowRequest request,
                                                      AsyncHandler<RunScheduledJobNowRequest,RunScheduledJobNowResponse> handler)

Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly scheduled time. This operation only applies to recurring jobs, not one-time scheduled jobs.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateScheduledJob

Future<UpdateScheduledJobResponse> updateScheduledJob(UpdateScheduledJobRequest request,
                                                      AsyncHandler<UpdateScheduledJobRequest,UpdateScheduledJobResponse> handler)

Updates the specified scheduled job’s name, description, and other details, such as next execution and recurrence.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.