@Generated(value="OracleSDKGenerator", comments="API Version: 20200107") public class UsageapiClient extends Object 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.
|
Modifier | Constructor and Description |
---|---|
|
UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
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.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
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)
Sets the endpoint to call (ex, https://www.example.com).
|
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’).
|
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
|
public static final Service SERVICE
Service instance for Usageapi.
public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public UsageapiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected UsageapiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the UsageapiClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static UsageapiClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Usageapi
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Usageapi
endpoint
- The endpoint of the service.public String getEndpoint()
Usageapi
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Usageapi
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 void close()
close
in interface AutoCloseable
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
Copyright © 2016–2022. All rights reserved.