Package com.oracle.bmc.resourceanalytics

Class ResourceAnalyticsInstanceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.resourceanalytics.ResourceAnalyticsInstanceClient

All Implemented Interfaces:

ResourceAnalyticsInstance, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20241031")
public class ResourceAnalyticsInstanceClient
extends BaseSyncClient
implements ResourceAnalyticsInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceAnalyticsInstanceClient.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 ResourceAnalyticsInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ResourceAnalyticsInstanceClient.Builder	builder()	Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	Cancels a work request.
ChangeResourceAnalyticsInstanceCompartmentResponse	changeResourceAnalyticsInstanceCompartment(ChangeResourceAnalyticsInstanceCompartmentRequest request)	Moves a ResourceAnalyticsInstance into a different compartment within the same tenancy.
void	close()
CreateResourceAnalyticsInstanceResponse	createResourceAnalyticsInstance(CreateResourceAnalyticsInstanceRequest request)	Creates a ResourceAnalyticsInstance.
DeleteResourceAnalyticsInstanceResponse	deleteResourceAnalyticsInstance(DeleteResourceAnalyticsInstanceRequest request)	Deletes a ResourceAnalyticsInstance.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ResourceAnalyticsInstancePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetResourceAnalyticsInstanceResponse	getResourceAnalyticsInstance(GetResourceAnalyticsInstanceRequest request)	Gets information about a ResourceAnalyticsInstance.
ResourceAnalyticsInstanceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the details of a work request.
ListResourceAnalyticsInstancesResponse	listResourceAnalyticsInstances(ListResourceAnalyticsInstancesRequest request)	Gets a list of ResourceAnalyticsInstances.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Lists the errors for a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Lists the logs for a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	Lists the work requests in a compartment.
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.
ResourceAnalyticsInstanceDisableOacResponse	resourceAnalyticsInstanceDisableOac(ResourceAnalyticsInstanceDisableOacRequest request)	Disable an OAC instance for a ResourceAnalyticsInstance.
ResourceAnalyticsInstanceEnableOacResponse	resourceAnalyticsInstanceEnableOac(ResourceAnalyticsInstanceEnableOacRequest request)	Attaches an OAC instance to a ResourceAnalyticsInstance.
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.
UpdateResourceAnalyticsInstanceResponse	updateResourceAnalyticsInstance(UpdateResourceAnalyticsInstanceRequest request)	Updates a ResourceAnalyticsInstance.
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.resourceanalytics.ResourceAnalyticsInstance

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ResourceAnalyticsInstance.

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

ResourceAnalyticsInstanceClient

@Deprecated
public ResourceAnalyticsInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ResourceAnalyticsInstanceClient

@Deprecated
public ResourceAnalyticsInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ResourceAnalyticsInstanceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ResourceAnalyticsInstanceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ResourceAnalyticsInstanceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ResourceAnalyticsInstanceClient

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

ResourceAnalyticsInstanceClient

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

ResourceAnalyticsInstanceClient

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

Method Detail

builder

public static ResourceAnalyticsInstanceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ResourceAnalyticsInstance

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 ResourceAnalyticsInstance

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ResourceAnalyticsInstance

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 ResourceAnalyticsInstance

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: ResourceAnalyticsInstance

Cancels a work request.

Specified by:

cancelWorkRequest in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeResourceAnalyticsInstanceCompartment

public ChangeResourceAnalyticsInstanceCompartmentResponse changeResourceAnalyticsInstanceCompartment(ChangeResourceAnalyticsInstanceCompartmentRequest request)

Description copied from interface: ResourceAnalyticsInstance

Moves a ResourceAnalyticsInstance into a different compartment within the same tenancy.

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

Specified by:

changeResourceAnalyticsInstanceCompartment in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createResourceAnalyticsInstance

public CreateResourceAnalyticsInstanceResponse createResourceAnalyticsInstance(CreateResourceAnalyticsInstanceRequest request)

Description copied from interface: ResourceAnalyticsInstance

Creates a ResourceAnalyticsInstance.

Specified by:

createResourceAnalyticsInstance in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteResourceAnalyticsInstance

public DeleteResourceAnalyticsInstanceResponse deleteResourceAnalyticsInstance(DeleteResourceAnalyticsInstanceRequest request)

Description copied from interface: ResourceAnalyticsInstance

Deletes a ResourceAnalyticsInstance.

Specified by:

deleteResourceAnalyticsInstance in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getResourceAnalyticsInstance

public GetResourceAnalyticsInstanceResponse getResourceAnalyticsInstance(GetResourceAnalyticsInstanceRequest request)

Description copied from interface: ResourceAnalyticsInstance

Gets information about a ResourceAnalyticsInstance.

Specified by:

getResourceAnalyticsInstance in interface ResourceAnalyticsInstance

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: ResourceAnalyticsInstance

Gets the details of a work request.

Specified by:

getWorkRequest in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listResourceAnalyticsInstances

public ListResourceAnalyticsInstancesResponse listResourceAnalyticsInstances(ListResourceAnalyticsInstancesRequest request)

Description copied from interface: ResourceAnalyticsInstance

Gets a list of ResourceAnalyticsInstances.

Specified by:

listResourceAnalyticsInstances in interface ResourceAnalyticsInstance

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: ResourceAnalyticsInstance

Lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface ResourceAnalyticsInstance

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: ResourceAnalyticsInstance

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface ResourceAnalyticsInstance

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: ResourceAnalyticsInstance

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

resourceAnalyticsInstanceDisableOac

public ResourceAnalyticsInstanceDisableOacResponse resourceAnalyticsInstanceDisableOac(ResourceAnalyticsInstanceDisableOacRequest request)

Description copied from interface: ResourceAnalyticsInstance

Disable an OAC instance for a ResourceAnalyticsInstance.

Specified by:

resourceAnalyticsInstanceDisableOac in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

resourceAnalyticsInstanceEnableOac

public ResourceAnalyticsInstanceEnableOacResponse resourceAnalyticsInstanceEnableOac(ResourceAnalyticsInstanceEnableOacRequest request)

Description copied from interface: ResourceAnalyticsInstance

Attaches an OAC instance to a ResourceAnalyticsInstance.

Specified by:

resourceAnalyticsInstanceEnableOac in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateResourceAnalyticsInstance

public UpdateResourceAnalyticsInstanceResponse updateResourceAnalyticsInstance(UpdateResourceAnalyticsInstanceRequest request)

Description copied from interface: ResourceAnalyticsInstance

Updates a ResourceAnalyticsInstance.

Specified by:

updateResourceAnalyticsInstance in interface ResourceAnalyticsInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ResourceAnalyticsInstanceWaiters getWaiters()

Description copied from interface: ResourceAnalyticsInstance

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

Specified by:

getWaiters in interface ResourceAnalyticsInstance

Returns:

The service waiters.

getPaginators

public ResourceAnalyticsInstancePaginators getPaginators()

Description copied from interface: ResourceAnalyticsInstance

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 ResourceAnalyticsInstance

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