com.oracle.bmc.osmanagementhub

Class ManagementStationClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.ManagementStationClient

All Implemented Interfaces:

ManagementStation, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class ManagementStationClient
extends BaseSyncClient
implements ManagementStation

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and 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 ManagementStation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ManagementStationClient.Builder	builder() Create a builder for this client.
ChangeManagementStationCompartmentResponse	changeManagementStationCompartment(ChangeManagementStationCompartmentRequest request) Moves a managment station to a different compartment.
void	close()
CreateManagementStationResponse	createManagementStation(CreateManagementStationRequest request) Creates a management station using the proxy and mirror configuration information provided.
DeleteManagementStationResponse	deleteManagementStation(DeleteManagementStationRequest request) Deletes a management station.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetManagementStationResponse	getManagementStation(GetManagementStationRequest request) Returns information about the specified management station.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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 within the specified compartment.
ListMirrorsResponse	listMirrors(ListMirrorsRequest request) Lists all software source mirrors associated with a specified management station.
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.
RefreshManagementStationConfigResponse	refreshManagementStationConfig(RefreshManagementStationConfigRequest request) Refreshes the list of software sources mirrored by the management station.
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’).
SynchronizeMirrorsResponse	synchronizeMirrors(SynchronizeMirrorsRequest request) Synchronize the specified software sources mirrored on the management station.
SynchronizeSingleMirrorsResponse	synchronizeSingleMirrors(SynchronizeSingleMirrorsRequest request) Synchronize the specified software source mirrors on the management station.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateManagementStationResponse	updateManagementStation(UpdateManagementStationRequest request) Updates the configuration of the specified management station.
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 com.oracle.bmc.osmanagementhub.ManagementStation

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagementStation.

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

ManagementStationClient

@Deprecated
public ManagementStationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ManagementStationClient

@Deprecated
public ManagementStationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagementStationClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagementStationClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagementStationClient

@Deprecated
public ManagementStationClient(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 ManagementStationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagementStationClient

@Deprecated
public ManagementStationClient(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 ManagementStationClient.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)

ManagementStationClient

@Deprecated
public ManagementStationClient(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 ManagementStationClient.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

ManagementStationClient

@Deprecated
public ManagementStationClient(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 ManagementStationClient.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 - ManagementStationClient.Builder.executorService

Method Detail

builder

public static ManagementStationClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagementStation

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 ManagementStation

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagementStation

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 ManagementStation

Parameters:

regionId - The public region ID.

changeManagementStationCompartment

public ChangeManagementStationCompartmentResponse changeManagementStationCompartment(ChangeManagementStationCompartmentRequest request)

Description copied from interface: ManagementStation

Moves a managment station to a different compartment.

Specified by:

changeManagementStationCompartment in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createManagementStation

public CreateManagementStationResponse createManagementStation(CreateManagementStationRequest request)

Description copied from interface: ManagementStation

Creates a management station using the proxy and mirror configuration information provided.

Specified by:

createManagementStation in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteManagementStation

public DeleteManagementStationResponse deleteManagementStation(DeleteManagementStationRequest request)

Description copied from interface: ManagementStation

Deletes a management station. You can’t delete a station if there are resources associated with the station (such as instances using the station or profiles associated with the station). Switch stations and edit profiles as needed before deleting the station.

Specified by:

deleteManagementStation in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getManagementStation

public GetManagementStationResponse getManagementStation(GetManagementStationRequest request)

Description copied from interface: ManagementStation

Returns information about the specified management station.

Specified by:

getManagementStation in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagementStations

public ListManagementStationsResponse listManagementStations(ListManagementStationsRequest request)

Description copied from interface: ManagementStation

Lists management stations within the specified compartment. Filter the list against a variety of criteria including but not limited to name, status, and location.

Specified by:

listManagementStations in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMirrors

public ListMirrorsResponse listMirrors(ListMirrorsRequest request)

Description copied from interface: ManagementStation

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

Specified by:

listMirrors in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshManagementStationConfig

public RefreshManagementStationConfigResponse refreshManagementStationConfig(RefreshManagementStationConfigRequest request)

Description copied from interface: ManagementStation

Refreshes the list of software sources mirrored by the management station.

Specified by:

refreshManagementStationConfig in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

synchronizeMirrors

public SynchronizeMirrorsResponse synchronizeMirrors(SynchronizeMirrorsRequest request)

Description copied from interface: ManagementStation

Synchronize the specified software sources mirrored on the management station.

Specified by:

synchronizeMirrors in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

synchronizeSingleMirrors

public SynchronizeSingleMirrorsResponse synchronizeSingleMirrors(SynchronizeSingleMirrorsRequest request)

Description copied from interface: ManagementStation

Synchronize the specified software source mirrors on the management station.

Specified by:

synchronizeSingleMirrors in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateManagementStation

public UpdateManagementStationResponse updateManagementStation(UpdateManagementStationRequest request)

Description copied from interface: ManagementStation

Updates the configuration of the specified management station.

Specified by:

updateManagementStation in interface ManagementStation

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ManagementStationWaiters getWaiters()

Description copied from interface: ManagementStation

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

Specified by:

getWaiters in interface ManagementStation

Returns:

The service waiters.

getPaginators

public ManagementStationPaginators getPaginators()

Description copied from interface: ManagementStation

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 ManagementStation

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()