com.oracle.bmc.osubbillingschedule

Class BillingScheduleAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osubbillingschedule.BillingScheduleAsyncClient

All Implemented Interfaces:

BillingScheduleAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210501")
public class BillingScheduleAsyncClient
extends BaseAsyncClient
implements BillingScheduleAsync

Async client implementation for BillingSchedule service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion
Optional<String>	minimumClientCommonLibraryVersionFromClient
static Service	SERVICE Service instance for BillingSchedule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BillingScheduleAsyncClient.Builder	builder() Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ arg0, Supplier<RESP_BUILDER> arg1)
void	close()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<ListBillingSchedulesResponse>	listBillingSchedules(ListBillingSchedulesRequest request, AsyncHandler<ListBillingSchedulesRequest,ListBillingSchedulesResponse> handler) This list API returns all billing schedules for given subscription id and for a particular Subscribed Service if provided
void	populateServiceParametersInEndpoint(String arg0, Map<String,Object> arg1)
void	refreshClient()
void	setEndpoint(String arg0)
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 arg0)

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.osubbillingschedule.BillingScheduleAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for BillingSchedule.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Constructor Detail

BillingScheduleAsyncClient

@Deprecated
public BillingScheduleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

BillingScheduleAsyncClient

@Deprecated
public BillingScheduleAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

BillingScheduleAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

BillingScheduleAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

BillingScheduleAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

BillingScheduleAsyncClient

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

BillingScheduleAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static BillingScheduleAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: BillingScheduleAsync

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 BillingScheduleAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: BillingScheduleAsync

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 BillingScheduleAsync

Parameters:

regionId - The public region ID.

listBillingSchedules

public Future<ListBillingSchedulesResponse> listBillingSchedules(ListBillingSchedulesRequest request,
                                                                 AsyncHandler<ListBillingSchedulesRequest,ListBillingSchedulesResponse> handler)

Description copied from interface: BillingScheduleAsync

This list API returns all billing schedules for given subscription id and for a particular Subscribed Service if provided

Specified by:

listBillingSchedules in interface BillingScheduleAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String arg0,
                                                      Map<String,Object> arg1)

updateBaseEndpoint

public final void updateBaseEndpoint(String arg0)

setEndpoint

public final void setEndpoint(String arg0)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

close

public final void close()

Specified by:

close in interface AutoCloseable

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ arg0,
                                                                                                                                                           Supplier<RESP_BUILDER> arg1)