com.oracle.bmc.usageapi

Class UsageapiClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.usageapi.UsageapiClient

All Implemented Interfaces:

Usageapi, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200107")
public class UsageapiClient
extends BaseSyncClient
implements Usageapi

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static UsageapiClient.Builder	builder() Create a builder for this client.
void	close()
CreateCustomTableResponse	createCustomTable(CreateCustomTableRequest request) Returns the created custom table.
CreateQueryResponse	createQuery(CreateQueryRequest request) Returns the created query.
CreateScheduleResponse	createSchedule(CreateScheduleRequest request) Returns the created schedule.
DeleteCustomTableResponse	deleteCustomTable(DeleteCustomTableRequest request) Delete a saved custom table by the OCID.
DeleteQueryResponse	deleteQuery(DeleteQueryRequest request) Delete a saved query by the OCID.
DeleteScheduleResponse	deleteSchedule(DeleteScheduleRequest request) Delete a saved scheduled report by the OCID.
GetCustomTableResponse	getCustomTable(GetCustomTableRequest request) Returns the saved custom table.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
UsageapiPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetQueryResponse	getQuery(GetQueryRequest request) Returns the saved query.
GetScheduleResponse	getSchedule(GetScheduleRequest request) Returns the saved schedule.
GetScheduledRunResponse	getScheduledRun(GetScheduledRunRequest request) Returns the saved schedule run.
UsageapiWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListCustomTablesResponse	listCustomTables(ListCustomTablesRequest request) Returns the saved custom table list.
ListQueriesResponse	listQueries(ListQueriesRequest request) Returns the saved query list.
ListScheduledRunsResponse	listScheduledRuns(ListScheduledRunsRequest request) Returns schedule history list.
ListSchedulesResponse	listSchedules(ListSchedulesRequest request) Returns the saved schedule list.
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.
RequestSummarizedConfigurationsResponse	requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request) Returns the configurations list for the UI drop-down list.
RequestSummarizedUsagesResponse	requestSummarizedUsages(RequestSummarizedUsagesRequest request) Returns usage for the given account.
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.
UpdateCustomTableResponse	updateCustomTable(UpdateCustomTableRequest request) Update a saved custom table by table id.
UpdateQueryResponse	updateQuery(UpdateQueryRequest request) Update a saved query by the OCID.
UpdateScheduleResponse	updateSchedule(UpdateScheduleRequest request) Update a saved schedule
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.usageapi.Usageapi

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Usageapi.

Constructor Detail

UsageapiClient

@Deprecated
public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

UsageapiClient

@Deprecated
public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

UsageapiClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

UsageapiClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

UsageapiClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

UsageapiClient

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

UsageapiClient

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

UsageapiClient

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

Method Detail

builder

public static UsageapiClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Usageapi

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 Usageapi

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Usageapi

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 Usageapi

Parameters:

regionId - The public region ID.

createCustomTable

public CreateCustomTableResponse createCustomTable(CreateCustomTableRequest request)

Description copied from interface: Usageapi

Returns the created custom table.

Specified by:

createCustomTable in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createQuery

public CreateQueryResponse createQuery(CreateQueryRequest request)

Description copied from interface: Usageapi

Returns the created query.

Specified by:

createQuery in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSchedule

public CreateScheduleResponse createSchedule(CreateScheduleRequest request)

Description copied from interface: Usageapi

Returns the created schedule.

Specified by:

createSchedule in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCustomTable

public DeleteCustomTableResponse deleteCustomTable(DeleteCustomTableRequest request)

Description copied from interface: Usageapi

Delete a saved custom table by the OCID.

Specified by:

deleteCustomTable in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteQuery

public DeleteQueryResponse deleteQuery(DeleteQueryRequest request)

Description copied from interface: Usageapi

Delete a saved query by the OCID.

Specified by:

deleteQuery in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSchedule

public DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)

Description copied from interface: Usageapi

Delete a saved scheduled report by the OCID.

Specified by:

deleteSchedule in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCustomTable

public GetCustomTableResponse getCustomTable(GetCustomTableRequest request)

Description copied from interface: Usageapi

Returns the saved custom table.

Specified by:

getCustomTable in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getQuery

public GetQueryResponse getQuery(GetQueryRequest request)

Description copied from interface: Usageapi

Returns the saved query.

Specified by:

getQuery in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSchedule

public GetScheduleResponse getSchedule(GetScheduleRequest request)

Description copied from interface: Usageapi

Returns the saved schedule.

Specified by:

getSchedule in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getScheduledRun

public GetScheduledRunResponse getScheduledRun(GetScheduledRunRequest request)

Description copied from interface: Usageapi

Returns the saved schedule run.

Specified by:

getScheduledRun in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCustomTables

public ListCustomTablesResponse listCustomTables(ListCustomTablesRequest request)

Description copied from interface: Usageapi

Returns the saved custom table list.

Specified by:

listCustomTables in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listQueries

public ListQueriesResponse listQueries(ListQueriesRequest request)

Description copied from interface: Usageapi

Returns the saved query list.

Specified by:

listQueries in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listScheduledRuns

public ListScheduledRunsResponse listScheduledRuns(ListScheduledRunsRequest request)

Description copied from interface: Usageapi

Returns schedule history list.

Specified by:

listScheduledRuns in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSchedules

public ListSchedulesResponse listSchedules(ListSchedulesRequest request)

Description copied from interface: Usageapi

Returns the saved schedule list.

Specified by:

listSchedules in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestSummarizedConfigurations

public RequestSummarizedConfigurationsResponse requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request)

Description copied from interface: Usageapi

Returns the configurations list for the UI drop-down list.

Specified by:

requestSummarizedConfigurations in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestSummarizedUsages

public RequestSummarizedUsagesResponse requestSummarizedUsages(RequestSummarizedUsagesRequest request)

Description copied from interface: Usageapi

Returns usage for the given account.

Specified by:

requestSummarizedUsages in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCustomTable

public UpdateCustomTableResponse updateCustomTable(UpdateCustomTableRequest request)

Description copied from interface: Usageapi

Update a saved custom table by table id.

Specified by:

updateCustomTable in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateQuery

public UpdateQueryResponse updateQuery(UpdateQueryRequest request)

Description copied from interface: Usageapi

Update a saved query by the OCID.

Specified by:

updateQuery in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSchedule

public UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)

Description copied from interface: Usageapi

Update a saved schedule

Specified by:

updateSchedule in interface Usageapi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public UsageapiWaiters getWaiters()

Description copied from interface: Usageapi

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

Specified by:

getWaiters in interface Usageapi

Returns:

The service waiters.

getPaginators

public UsageapiPaginators getPaginators()

Description copied from interface: Usageapi

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 Usageapi

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