com.oracle.bmc.announcementsservice

Class AnnouncementSubscriptionAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.announcementsservice.AnnouncementSubscriptionAsyncClient

All Implemented Interfaces:

AnnouncementSubscriptionAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 0.0.1")
public class AnnouncementSubscriptionAsyncClient
extends BaseAsyncClient
implements AnnouncementSubscriptionAsync

Async client implementation for AnnouncementSubscription 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	AnnouncementSubscriptionAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 AnnouncementSubscription.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AnnouncementSubscriptionAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeAnnouncementSubscriptionCompartmentResponse>	changeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest request, AsyncHandler<ChangeAnnouncementSubscriptionCompartmentRequest,ChangeAnnouncementSubscriptionCompartmentResponse> handler) Moves the specified announcement subscription from one compartment to another compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateAnnouncementSubscriptionResponse>	createAnnouncementSubscription(CreateAnnouncementSubscriptionRequest request, AsyncHandler<CreateAnnouncementSubscriptionRequest,CreateAnnouncementSubscriptionResponse> handler) Creates a new announcement subscription.
Future<CreateFilterGroupResponse>	createFilterGroup(CreateFilterGroupRequest request, AsyncHandler<CreateFilterGroupRequest,CreateFilterGroupResponse> handler) Creates a new filter group in the specified announcement subscription.
Future<DeleteAnnouncementSubscriptionResponse>	deleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest request, AsyncHandler<DeleteAnnouncementSubscriptionRequest,DeleteAnnouncementSubscriptionResponse> handler) Deletes the specified announcement subscription.
Future<DeleteFilterGroupResponse>	deleteFilterGroup(DeleteFilterGroupRequest request, AsyncHandler<DeleteFilterGroupRequest,DeleteFilterGroupResponse> handler) Deletes a filter group in the specified announcement subscription.
Future<GetAnnouncementSubscriptionResponse>	getAnnouncementSubscription(GetAnnouncementSubscriptionRequest request, AsyncHandler<GetAnnouncementSubscriptionRequest,GetAnnouncementSubscriptionResponse> handler) Gets the specified announcement subscription.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ListAnnouncementSubscriptionsResponse>	listAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest request, AsyncHandler<ListAnnouncementSubscriptionsRequest,ListAnnouncementSubscriptionsResponse> handler) Gets a list of all announcement subscriptions in the specified compartment.
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.
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’).
Future<UpdateAnnouncementSubscriptionResponse>	updateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request, AsyncHandler<UpdateAnnouncementSubscriptionRequest,UpdateAnnouncementSubscriptionResponse> handler) Updates the specified announcement subscription.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateFilterGroupResponse>	updateFilterGroup(UpdateFilterGroupRequest request, AsyncHandler<UpdateFilterGroupRequest,UpdateFilterGroupResponse> handler) Updates a filter group in the specified announcement subscription.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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.announcementsservice.AnnouncementSubscriptionAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AnnouncementSubscription.

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

AnnouncementSubscriptionAsyncClient

@Deprecated
public AnnouncementSubscriptionAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

AnnouncementSubscriptionAsyncClient

@Deprecated
public AnnouncementSubscriptionAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                       ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

AnnouncementSubscriptionAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

AnnouncementSubscriptionAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AnnouncementSubscriptionAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AnnouncementSubscriptionAsyncClient

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

AnnouncementSubscriptionAsyncClient

@Deprecated
public AnnouncementSubscriptionAsyncClient(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 AnnouncementSubscriptionAsyncClient.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 AnnouncementSubscriptionAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AnnouncementSubscriptionAsync

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 AnnouncementSubscriptionAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AnnouncementSubscriptionAsync

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 AnnouncementSubscriptionAsync

Parameters:

regionId - The public region ID.

changeAnnouncementSubscriptionCompartment

public Future<ChangeAnnouncementSubscriptionCompartmentResponse> changeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest request,
                                                                                                           AsyncHandler<ChangeAnnouncementSubscriptionCompartmentRequest,ChangeAnnouncementSubscriptionCompartmentResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

changeAnnouncementSubscriptionCompartment in interface AnnouncementSubscriptionAsync

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.

createAnnouncementSubscription

public Future<CreateAnnouncementSubscriptionResponse> createAnnouncementSubscription(CreateAnnouncementSubscriptionRequest request,
                                                                                     AsyncHandler<CreateAnnouncementSubscriptionRequest,CreateAnnouncementSubscriptionResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Creates a new announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

createAnnouncementSubscription in interface AnnouncementSubscriptionAsync

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.

createFilterGroup

public Future<CreateFilterGroupResponse> createFilterGroup(CreateFilterGroupRequest request,
                                                           AsyncHandler<CreateFilterGroupRequest,CreateFilterGroupResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Creates a new filter group in the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

createFilterGroup in interface AnnouncementSubscriptionAsync

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.

deleteAnnouncementSubscription

public Future<DeleteAnnouncementSubscriptionResponse> deleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest request,
                                                                                     AsyncHandler<DeleteAnnouncementSubscriptionRequest,DeleteAnnouncementSubscriptionResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Deletes the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

deleteAnnouncementSubscription in interface AnnouncementSubscriptionAsync

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.

deleteFilterGroup

public Future<DeleteFilterGroupResponse> deleteFilterGroup(DeleteFilterGroupRequest request,
                                                           AsyncHandler<DeleteFilterGroupRequest,DeleteFilterGroupResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Deletes a filter group in the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

deleteFilterGroup in interface AnnouncementSubscriptionAsync

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.

getAnnouncementSubscription

public Future<GetAnnouncementSubscriptionResponse> getAnnouncementSubscription(GetAnnouncementSubscriptionRequest request,
                                                                               AsyncHandler<GetAnnouncementSubscriptionRequest,GetAnnouncementSubscriptionResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Gets the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

getAnnouncementSubscription in interface AnnouncementSubscriptionAsync

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.

listAnnouncementSubscriptions

public Future<ListAnnouncementSubscriptionsResponse> listAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest request,
                                                                                   AsyncHandler<ListAnnouncementSubscriptionsRequest,ListAnnouncementSubscriptionsResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Gets a list of all announcement subscriptions in the specified compartment.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

listAnnouncementSubscriptions in interface AnnouncementSubscriptionAsync

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.

updateAnnouncementSubscription

public Future<UpdateAnnouncementSubscriptionResponse> updateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request,
                                                                                     AsyncHandler<UpdateAnnouncementSubscriptionRequest,UpdateAnnouncementSubscriptionResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Updates the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

updateAnnouncementSubscription in interface AnnouncementSubscriptionAsync

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.

updateFilterGroup

public Future<UpdateFilterGroupResponse> updateFilterGroup(UpdateFilterGroupRequest request,
                                                           AsyncHandler<UpdateFilterGroupRequest,UpdateFilterGroupResponse> handler)

Description copied from interface: AnnouncementSubscriptionAsync

Updates a filter group in the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Specified by:

updateFilterGroup in interface AnnouncementSubscriptionAsync

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()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

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