@Generated(value="OracleSDKGenerator", comments="API Version: 20200107") public class UsageapiClient extends BaseSyncClient implements Usageapi
Modifier and Type | Class and Description |
---|---|
static class |
UsageapiClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Usageapi.
|
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. |
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.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Usageapi.
@Deprecated public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see UsageapiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see UsageapiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see UsageapiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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)
@Deprecated public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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
@Deprecated public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
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
public static UsageapiClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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
.
public CreateCustomTableResponse createCustomTable(CreateCustomTableRequest request)
Usageapi
Returns the created custom table.
createCustomTable
in interface Usageapi
request
- The request object containing the details to sendpublic CreateQueryResponse createQuery(CreateQueryRequest request)
Usageapi
Returns the created query.
createQuery
in interface Usageapi
request
- The request object containing the details to sendpublic CreateScheduleResponse createSchedule(CreateScheduleRequest request)
Usageapi
Returns the created schedule.
createSchedule
in interface Usageapi
request
- The request object containing the details to sendpublic DeleteCustomTableResponse deleteCustomTable(DeleteCustomTableRequest request)
Usageapi
Delete a saved custom table by the OCID.
deleteCustomTable
in interface Usageapi
request
- The request object containing the details to sendpublic DeleteQueryResponse deleteQuery(DeleteQueryRequest request)
Usageapi
Delete a saved query by the OCID.
deleteQuery
in interface Usageapi
request
- The request object containing the details to sendpublic DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)
Usageapi
Delete a saved scheduled report by the OCID.
deleteSchedule
in interface Usageapi
request
- The request object containing the details to sendpublic GetCustomTableResponse getCustomTable(GetCustomTableRequest request)
Usageapi
Returns the saved custom table.
getCustomTable
in interface Usageapi
request
- The request object containing the details to sendpublic GetQueryResponse getQuery(GetQueryRequest request)
Usageapi
Returns the saved query.
public GetScheduleResponse getSchedule(GetScheduleRequest request)
Usageapi
Returns the saved schedule.
getSchedule
in interface Usageapi
request
- The request object containing the details to sendpublic GetScheduledRunResponse getScheduledRun(GetScheduledRunRequest request)
Usageapi
Returns the saved schedule run.
getScheduledRun
in interface Usageapi
request
- The request object containing the details to sendpublic ListCustomTablesResponse listCustomTables(ListCustomTablesRequest request)
Usageapi
Returns the saved custom table list.
listCustomTables
in interface Usageapi
request
- The request object containing the details to sendpublic ListQueriesResponse listQueries(ListQueriesRequest request)
Usageapi
Returns the saved query list.
listQueries
in interface Usageapi
request
- The request object containing the details to sendpublic ListScheduledRunsResponse listScheduledRuns(ListScheduledRunsRequest request)
Usageapi
Returns schedule history list.
listScheduledRuns
in interface Usageapi
request
- The request object containing the details to sendpublic ListSchedulesResponse listSchedules(ListSchedulesRequest request)
Usageapi
Returns the saved schedule list.
listSchedules
in interface Usageapi
request
- The request object containing the details to sendpublic RequestSummarizedConfigurationsResponse requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request)
Usageapi
Returns the configurations list for the UI drop-down list.
requestSummarizedConfigurations
in interface Usageapi
request
- The request object containing the details to sendpublic RequestSummarizedUsagesResponse requestSummarizedUsages(RequestSummarizedUsagesRequest request)
Usageapi
Returns usage for the given account.
requestSummarizedUsages
in interface Usageapi
request
- The request object containing the details to sendpublic UpdateCustomTableResponse updateCustomTable(UpdateCustomTableRequest request)
Usageapi
Update a saved custom table by table id.
updateCustomTable
in interface Usageapi
request
- The request object containing the details to sendpublic UpdateQueryResponse updateQuery(UpdateQueryRequest request)
Usageapi
Update a saved query by the OCID.
updateQuery
in interface Usageapi
request
- The request object containing the details to sendpublic UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)
Usageapi
Update a saved schedule
updateSchedule
in interface Usageapi
request
- The request object containing the details to sendpublic UsageapiWaiters getWaiters()
Usageapi
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Usageapi
public UsageapiPaginators getPaginators()
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.
getPaginators
in interface Usageapi
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.