com.oracle.bmc.fleetappsmanagement

Interface FleetAppsManagementMaintenanceWindow

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FleetAppsManagementMaintenanceWindowClient

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

Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CreateMaintenanceWindowResponse	createMaintenanceWindow(CreateMaintenanceWindowRequest request) Create a maintenance window in Fleet Application Management.
DeleteMaintenanceWindowResponse	deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request) Delete a maintenance window in Fleet Application Management.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetMaintenanceWindowResponse	getMaintenanceWindow(GetMaintenanceWindowRequest request) Get the details for a maintenance window in Fleet Application Management.
FleetAppsManagementMaintenanceWindowPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
FleetAppsManagementMaintenanceWindowWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListMaintenanceWindowsResponse	listMaintenanceWindows(ListMaintenanceWindowsRequest request) List maintenance windows for a specified tenancy in Fleet Application Management.
void	refreshClient() Rebuilds the client from scratch.
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’).
UpdateMaintenanceWindowResponse	updateMaintenanceWindow(UpdateMaintenanceWindowRequest request) Update a maintenance window in Fleet Application Management.
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 service.

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

createMaintenanceWindow

CreateMaintenanceWindowResponse createMaintenanceWindow(CreateMaintenanceWindowRequest request)

Create a maintenance window in Fleet Application Management.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateMaintenanceWindow API.

deleteMaintenanceWindow

DeleteMaintenanceWindowResponse deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)

Delete a maintenance window in Fleet Application Management.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteMaintenanceWindow API.

getMaintenanceWindow

GetMaintenanceWindowResponse getMaintenanceWindow(GetMaintenanceWindowRequest request)

Get the details for a maintenance window in Fleet Application Management.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetMaintenanceWindow API.

listMaintenanceWindows

ListMaintenanceWindowsResponse listMaintenanceWindows(ListMaintenanceWindowsRequest request)

List maintenance windows for a specified tenancy in Fleet Application Management.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListMaintenanceWindows API.

updateMaintenanceWindow

UpdateMaintenanceWindowResponse updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)

Update a maintenance window in Fleet Application Management.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateMaintenanceWindow API.

getWaiters

FleetAppsManagementMaintenanceWindowWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

FleetAppsManagementMaintenanceWindowPaginators getPaginators()

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.

Returns:

The service paginators.