Package com.oracle.bmc.resourcescheduler

Class ScheduleClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.resourcescheduler.ScheduleClient

All Implemented Interfaces:

Schedule, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240430")
public class ScheduleClient
extends BaseSyncClient
implements Schedule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScheduleClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Schedule.

Constructor Summary

Constructors

Constructor	Description
ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
ScheduleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
ScheduleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
ScheduleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
ActivateScheduleResponse	activateSchedule(ActivateScheduleRequest request)	This API activates a schedule.
static ScheduleClient.Builder	builder()	Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	This API cancels a work request.
ChangeScheduleCompartmentResponse	changeScheduleCompartment(ChangeScheduleCompartmentRequest request)	This API) moves a schedule into a different compartment within the same tenancy.
void	close()
CreateScheduleResponse	createSchedule(CreateScheduleRequest request)	This API creates a schedule.
DeactivateScheduleResponse	deactivateSchedule(DeactivateScheduleRequest request)	This API deactivates a schedule.
DeleteScheduleResponse	deleteSchedule(DeleteScheduleRequest request)	This API deletes a schedule.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
SchedulePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetScheduleResponse	getSchedule(GetScheduleRequest request)	This API gets information about a schedule.
ScheduleWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	This API gets the details of a work request.
ListResourceTypesResponse	listResourceTypes(ListResourceTypesRequest request)	This API gets a list of schedule resource types.
ListSchedulesResponse	listSchedules(ListSchedulesRequest request)	This API gets a list of schedules.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	This API lists the errors for a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Lists the logs for a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	This API gets a list of work requests.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateScheduleResponse	updateSchedule(UpdateScheduleRequest request)	The API updates a schedule
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.resourcescheduler.Schedule

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Schedule.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ScheduleClient

@Deprecated
public ScheduleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ScheduleClient

@Deprecated
public ScheduleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ScheduleClient

@Deprecated
public ScheduleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ScheduleClient

@Deprecated
public ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ScheduleClient

@Deprecated
public ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ScheduleClient

@Deprecated
public ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ScheduleClient

@Deprecated
public ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ScheduleClient

@Deprecated
public ScheduleClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint,
                      ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ScheduleClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ScheduleClient.Builder.executorService

Method Detail

builder

public static ScheduleClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Schedule

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.

Specified by:

setRegion in interface Schedule

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Schedule

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.

Specified by:

setRegion in interface Schedule

Parameters:

regionId - The public region ID.

activateSchedule

public ActivateScheduleResponse activateSchedule(ActivateScheduleRequest request)

Description copied from interface: Schedule

This API activates a schedule.

Specified by:

activateSchedule in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: Schedule

This API cancels a work request.

Specified by:

cancelWorkRequest in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeScheduleCompartment

public ChangeScheduleCompartmentResponse changeScheduleCompartment(ChangeScheduleCompartmentRequest request)

Description copied from interface: Schedule

This API) moves a schedule into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeScheduleCompartment in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSchedule

public CreateScheduleResponse createSchedule(CreateScheduleRequest request)

Description copied from interface: Schedule

This API creates a schedule.

You must provide either resources or resourceFilters.

Specified by:

createSchedule in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deactivateSchedule

public DeactivateScheduleResponse deactivateSchedule(DeactivateScheduleRequest request)

Description copied from interface: Schedule

This API deactivates a schedule.

Specified by:

deactivateSchedule in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSchedule

public DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)

Description copied from interface: Schedule

This API deletes a schedule.

Specified by:

deleteSchedule in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSchedule

public GetScheduleResponse getSchedule(GetScheduleRequest request)

Description copied from interface: Schedule

This API gets information about a schedule.

Specified by:

getSchedule in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: Schedule

This API gets the details of a work request.

Specified by:

getWorkRequest in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listResourceTypes

public ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest request)

Description copied from interface: Schedule

This API gets a list of schedule resource types.

Specified by:

listResourceTypes in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSchedules

public ListSchedulesResponse listSchedules(ListSchedulesRequest request)

Description copied from interface: Schedule

This API gets a list of schedules.

You must provide either a compartmentId or a scheduleId or both. You can list resources in this compartment OCID. This is required unless a specific schedule ID is passed.

Specified by:

listSchedules in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: Schedule

This API lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: Schedule

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: Schedule

This API gets a list of work requests.

You must provide either a compartmentId or a workRequestId or both. You can list work requests in this compartment OCID. This is required unless a specific workRequestId is passed.

Specified by:

listWorkRequests in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSchedule

public UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)

Description copied from interface: Schedule

The API updates a schedule

Specified by:

updateSchedule in interface Schedule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ScheduleWaiters getWaiters()

Description copied from interface: Schedule

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Schedule

Returns:

The service waiters.

getPaginators

public SchedulePaginators getPaginators()

Description copied from interface: Schedule

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface Schedule

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()