com.oracle.bmc.osmanagementhub

Interface ManagementStation

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ManagementStationClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface ManagementStation
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.

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
ChangeManagementStationCompartmentResponse	changeManagementStationCompartment(ChangeManagementStationCompartmentRequest request) Moves a managment station to a different compartment.
CreateManagementStationResponse	createManagementStation(CreateManagementStationRequest request) Create a management station.
DeleteManagementStationResponse	deleteManagementStation(DeleteManagementStationRequest request) Deletes a management station.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetManagementStationResponse	getManagementStation(GetManagementStationRequest request) Gets information about the specified management station.
ManagementStationPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ManagementStationWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListManagementStationsResponse	listManagementStations(ListManagementStationsRequest request) Lists management stations in a compartment.
ListMirrorsResponse	listMirrors(ListMirrorsRequest request) Lists all software source mirrors associated with a specified management station.
void	refreshClient() Rebuilds the client from scratch.
RefreshManagementStationConfigResponse	refreshManagementStationConfig(RefreshManagementStationConfigRequest request) Refreshes the list of software sources mirrored by the management station to support the associated instances.
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’).
SynchronizeMirrorsResponse	synchronizeMirrors(SynchronizeMirrorsRequest request) Synchronize the specified software sources mirrors on the management station.
SynchronizeSingleMirrorsResponse	synchronizeSingleMirrors(SynchronizeSingleMirrorsRequest request) Synchronize the specified software source mirrors on the management station.
UpdateManagementStationResponse	updateManagementStation(UpdateManagementStationRequest request) Updates the configuration of the specified management station.
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

changeManagementStationCompartment

ChangeManagementStationCompartmentResponse changeManagementStationCompartment(ChangeManagementStationCompartmentRequest request)

Moves a managment station to a different compartment.

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 ChangeManagementStationCompartment API.

createManagementStation

CreateManagementStationResponse createManagementStation(CreateManagementStationRequest request)

Create a management station. You must provide proxy and mirror configuration information.

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 CreateManagementStation API.

deleteManagementStation

DeleteManagementStationResponse deleteManagementStation(DeleteManagementStationRequest request)

Deletes a management station.

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 DeleteManagementStation API.

getManagementStation

GetManagementStationResponse getManagementStation(GetManagementStationRequest request)

Gets information about the specified management station.

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 GetManagementStation API.

listManagementStations

ListManagementStationsResponse listManagementStations(ListManagementStationsRequest request)

Lists management stations in a compartment.

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 ListManagementStations API.

listMirrors

ListMirrorsResponse listMirrors(ListMirrorsRequest request)

Lists all software source mirrors associated with a specified management station.

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 ListMirrors API.

refreshManagementStationConfig

RefreshManagementStationConfigResponse refreshManagementStationConfig(RefreshManagementStationConfigRequest request)

Refreshes the list of software sources mirrored by the management station to support the associated instances.

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 RefreshManagementStationConfig API.

synchronizeMirrors

SynchronizeMirrorsResponse synchronizeMirrors(SynchronizeMirrorsRequest request)

Synchronize the specified software sources mirrors on the management station.

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 SynchronizeMirrors API.

synchronizeSingleMirrors

SynchronizeSingleMirrorsResponse synchronizeSingleMirrors(SynchronizeSingleMirrorsRequest request)

Synchronize the specified software source mirrors on the management station.

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 SynchronizeSingleMirrors API.

updateManagementStation

UpdateManagementStationResponse updateManagementStation(UpdateManagementStationRequest request)

Updates the configuration of the specified management station.

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 UpdateManagementStation API.

getWaiters

ManagementStationWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

ManagementStationPaginators 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.