com.oracle.bmc.osubusage

Class ComputedUsageClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osubusage.ComputedUsageClient

All Implemented Interfaces:

ComputedUsage, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210501")
public class ComputedUsageClient
extends BaseSyncClient
implements ComputedUsage

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for ComputedUsage.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ComputedUsageClient.Builder	builder() Create a builder for this client.
void	close()
GetComputedUsageResponse	getComputedUsage(GetComputedUsageRequest request) This is an API which returns Computed Usage corresponding to the id passed
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
ComputedUsagePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListComputedUsageAggregatedsResponse	listComputedUsageAggregateds(ListComputedUsageAggregatedsRequest request) This is a collection API which returns a list of aggregated computed usage details (there can be multiple Parent Products under a given SubID each of which is represented under Subscription Service Line # in SPM).
ListComputedUsagesResponse	listComputedUsages(ListComputedUsagesRequest request) This is a collection API which returns a list of Computed Usages for given filters.
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.
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.osubusage.ComputedUsage

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ComputedUsage.

Constructor Detail

ComputedUsageClient

@Deprecated
public ComputedUsageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ComputedUsageClient

@Deprecated
public ComputedUsageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ComputedUsageClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ComputedUsageClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ComputedUsageClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ComputedUsageClient

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

ComputedUsageClient

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

Method Detail

builder

public static ComputedUsageClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ComputedUsage

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 ComputedUsage

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ComputedUsage

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 ComputedUsage

Parameters:

regionId - The public region ID.

getComputedUsage

public GetComputedUsageResponse getComputedUsage(GetComputedUsageRequest request)

Description copied from interface: ComputedUsage

This is an API which returns Computed Usage corresponding to the id passed

Specified by:

getComputedUsage in interface ComputedUsage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listComputedUsageAggregateds

public ListComputedUsageAggregatedsResponse listComputedUsageAggregateds(ListComputedUsageAggregatedsRequest request)

Description copied from interface: ComputedUsage

This is a collection API which returns a list of aggregated computed usage details (there can be multiple Parent Products under a given SubID each of which is represented under Subscription Service Line # in SPM).

Specified by:

listComputedUsageAggregateds in interface ComputedUsage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listComputedUsages

public ListComputedUsagesResponse listComputedUsages(ListComputedUsagesRequest request)

Description copied from interface: ComputedUsage

This is a collection API which returns a list of Computed Usages for given filters.

Specified by:

listComputedUsages in interface ComputedUsage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public ComputedUsagePaginators getPaginators()

Description copied from interface: ComputedUsage

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 ComputedUsage

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