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 Description

static class UsageapiClient.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 Usageapi.

Constructor Summary

Constructors
Constructor	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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UsageapiClient.Builder`	`builder()`	Create a builder for this client.
`void`	`close()`
`CreateCustomTableResponse`	`createCustomTable(CreateCustomTableRequest request)`	Returns the created custom table.
`CreateEmailRecipientsGroupResponse`	`createEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request)`	Creates a list of email recipients that can receive usage statements for the subscription.
`CreateQueryResponse`	`createQuery(CreateQueryRequest request)`	Returns the created query.
`CreateScheduleResponse`	`createSchedule(CreateScheduleRequest request)`	Returns the created schedule.
`CreateUsageCarbonEmissionsQueryResponse`	`createUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request)`	Returns the created carbon emissions usage query.
`DeleteCustomTableResponse`	`deleteCustomTable(DeleteCustomTableRequest request)`	Delete a saved custom table by the OCID.
`DeleteEmailRecipientsGroupResponse`	`deleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request)`	Deletes the email recipients group for the usage statement subscription.
`DeleteQueryResponse`	`deleteQuery(DeleteQueryRequest request)`	Delete a saved query by the OCID.
`DeleteScheduleResponse`	`deleteSchedule(DeleteScheduleRequest request)`	Delete a saved scheduled report by the OCID.
`DeleteUsageCarbonEmissionsQueryResponse`	`deleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request)`	Delete a carbon emissions usage saved query by the OCID.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`String`	`getClientCommonLibraryVersion()`
`GetCustomTableResponse`	`getCustomTable(GetCustomTableRequest request)`	Returns the saved custom table.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`GetEmailRecipientsGroupResponse`	`getEmailRecipientsGroup(GetEmailRecipientsGroupRequest request)`	Returns the saved usage statement email recipients group.
`String`	`getEndpoint()`	Get the endpoint of the client.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`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.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`GetScheduleResponse`	`getSchedule(GetScheduleRequest request)`	Returns the saved schedule.
`GetScheduledRunResponse`	`getScheduledRun(GetScheduledRunRequest request)`	Returns the saved schedule run.
`GetUsageCarbonEmissionsQueryResponse`	`getUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request)`	Returns the carbon emissions usage saved query.
`UsageapiWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListCustomTablesResponse`	`listCustomTables(ListCustomTablesRequest request)`	Returns the saved custom table list.
`ListEmailRecipientsGroupsResponse`	`listEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request)`	Returns the saved usage statement email recipients group.
`ListQueriesResponse`	`listQueries(ListQueriesRequest request)`	Returns the saved query list.
`ListScheduledRunsResponse`	`listScheduledRuns(ListScheduledRunsRequest request)`	Returns the schedule history list.
`ListSchedulesResponse`	`listSchedules(ListSchedulesRequest request)`	Returns the saved schedule list.
`ListUsageCarbonEmissionsQueriesResponse`	`listUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request)`	Returns the carbon emissions usage saved query list.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`RequestAverageCarbonEmissionResponse`	`requestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request)`	Returns the average carbon emissions summary by SKU.
`RequestCleanEnergyUsageResponse`	`requestCleanEnergyUsage(RequestCleanEnergyUsageRequest request)`	Returns the clean energy usage summary by region.
`RequestSummarizedConfigurationsResponse`	`requestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request)`	Returns the configurations list for the UI drop-down list.
`RequestSummarizedUsagesResponse`	`requestSummarizedUsages(RequestSummarizedUsagesRequest request)`	Returns usage for the given account.
`RequestUsageCarbonEmissionConfigResponse`	`requestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request)`	Returns the configuration list for the Console’s carbon emission user interface drop-down list.
`RequestUsageCarbonEmissionsResponse`	`requestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request)`	Returns carbon emission 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’).
`UpdateCustomTableResponse`	`updateCustomTable(UpdateCustomTableRequest request)`	Update a saved custom table by table ID.
`UpdateEmailRecipientsGroupResponse`	`updateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request)`	Updates a saved email recipients group.
`UpdateQueryResponse`	`updateQuery(UpdateQueryRequest request)`	Update a saved query by the OCID.
`UpdateScheduleResponse`	`updateSchedule(UpdateScheduleRequest request)`	Update a saved schedule.
`UpdateUsageCarbonEmissionsQueryResponse`	`updateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request)`	Update a carbon emissions usage saved query by the OCID.
`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.usageapi.Usageapi
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Usageapi.
  - 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
  - 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
  - createEmailRecipientsGroup
```
public CreateEmailRecipientsGroupResponse createEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request)
```
    Description copied from interface: Usageapi
    
    Creates a list of email recipients that can receive usage statements for the subscription.
    
    Specified by:
    
    createEmailRecipientsGroup 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
  - createUsageCarbonEmissionsQuery
```
public CreateUsageCarbonEmissionsQueryResponse createUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the created carbon emissions usage query.
    
    Specified by:
    
    createUsageCarbonEmissionsQuery 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
  - deleteEmailRecipientsGroup
```
public DeleteEmailRecipientsGroupResponse deleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request)
```
    Description copied from interface: Usageapi
    
    Deletes the email recipients group for the usage statement subscription.
    
    Specified by:
    
    deleteEmailRecipientsGroup 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
  - deleteUsageCarbonEmissionsQuery
```
public DeleteUsageCarbonEmissionsQueryResponse deleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request)
```
    Description copied from interface: Usageapi
    
    Delete a carbon emissions usage saved query by the OCID.
    
    Specified by:
    
    deleteUsageCarbonEmissionsQuery 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
  - getEmailRecipientsGroup
```
public GetEmailRecipientsGroupResponse getEmailRecipientsGroup(GetEmailRecipientsGroupRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the saved usage statement email recipients group.
    
    Specified by:
    
    getEmailRecipientsGroup 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
  - getUsageCarbonEmissionsQuery
```
public GetUsageCarbonEmissionsQueryResponse getUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the carbon emissions usage saved query.
    
    Specified by:
    
    getUsageCarbonEmissionsQuery 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
  - listEmailRecipientsGroups
```
public ListEmailRecipientsGroupsResponse listEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the saved usage statement email recipients group.
    
    Specified by:
    
    listEmailRecipientsGroups 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 the 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
  - listUsageCarbonEmissionsQueries
```
public ListUsageCarbonEmissionsQueriesResponse listUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the carbon emissions usage saved query list.
    
    Specified by:
    
    listUsageCarbonEmissionsQueries in interface Usageapi
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - requestAverageCarbonEmission
```
public RequestAverageCarbonEmissionResponse requestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the average carbon emissions summary by SKU.
    
    Specified by:
    
    requestAverageCarbonEmission in interface Usageapi
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - requestCleanEnergyUsage
```
public RequestCleanEnergyUsageResponse requestCleanEnergyUsage(RequestCleanEnergyUsageRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the clean energy usage summary by region.
    
    Specified by:
    
    requestCleanEnergyUsage 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
  - requestUsageCarbonEmissionConfig
```
public RequestUsageCarbonEmissionConfigResponse requestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request)
```
    Description copied from interface: Usageapi
    
    Returns the configuration list for the Console’s carbon emission user interface drop-down list.
    
    Specified by:
    
    requestUsageCarbonEmissionConfig in interface Usageapi
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - requestUsageCarbonEmissions
```
public RequestUsageCarbonEmissionsResponse requestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request)
```
    Description copied from interface: Usageapi
    
    Returns carbon emission usage for the given account.
    
    Specified by:
    
    requestUsageCarbonEmissions 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
  - updateEmailRecipientsGroup
```
public UpdateEmailRecipientsGroupResponse updateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request)
```
    Description copied from interface: Usageapi
    
    Updates a saved email recipients group.
    
    Specified by:
    
    updateEmailRecipientsGroup 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
  - updateUsageCarbonEmissionsQuery
```
public UpdateUsageCarbonEmissionsQueryResponse updateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request)
```
    Description copied from interface: Usageapi
    
    Update a carbon emissions usage saved query by the OCID.
    
    Specified by:
    
    updateUsageCarbonEmissionsQuery 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()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - 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
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - 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()
```

Class UsageapiClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.usageapi.Usageapi

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

UsageapiClient

UsageapiClient

UsageapiClient

UsageapiClient

UsageapiClient

UsageapiClient

UsageapiClient

UsageapiClient

Method Detail

builder

setRegion

setRegion

createCustomTable

createEmailRecipientsGroup

createQuery

createSchedule

createUsageCarbonEmissionsQuery

deleteCustomTable

deleteEmailRecipientsGroup

deleteQuery

deleteSchedule

deleteUsageCarbonEmissionsQuery

getCustomTable

getEmailRecipientsGroup

getQuery

getSchedule

getScheduledRun

getUsageCarbonEmissionsQuery

listCustomTables

listEmailRecipientsGroups

listQueries

listScheduledRuns

listSchedules

listUsageCarbonEmissionsQueries

requestAverageCarbonEmission

requestCleanEnergyUsage

requestSummarizedConfigurations

requestSummarizedUsages

requestUsageCarbonEmissionConfig

requestUsageCarbonEmissions

updateCustomTable

updateEmailRecipientsGroup

updateQuery

updateSchedule

updateUsageCarbonEmissionsQuery

getWaiters

getPaginators

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient