com.oracle.bmc.email

Class EmailAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.email.EmailAsyncClient

All Implemented Interfaces:

EmailAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public class EmailAsyncClient
extends BaseAsyncClient
implements EmailAsync

Async client implementation for Email 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	EmailAsyncClient.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 Email.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static EmailAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeEmailDomainCompartmentResponse>	changeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request, AsyncHandler<ChangeEmailDomainCompartmentRequest,ChangeEmailDomainCompartmentResponse> handler) Moves an email domain into a different compartment.
Future<ChangeSenderCompartmentResponse>	changeSenderCompartment(ChangeSenderCompartmentRequest request, AsyncHandler<ChangeSenderCompartmentRequest,ChangeSenderCompartmentResponse> handler) Moves a sender into a different 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<CreateDkimResponse>	createDkim(CreateDkimRequest request, AsyncHandler<CreateDkimRequest,CreateDkimResponse> handler) Creates a new DKIM for an email domain.
Future<CreateEmailDomainResponse>	createEmailDomain(CreateEmailDomainRequest request, AsyncHandler<CreateEmailDomainRequest,CreateEmailDomainResponse> handler) Creates a new email domain.
Future<CreateEmailReturnPathResponse>	createEmailReturnPath(CreateEmailReturnPathRequest request, AsyncHandler<CreateEmailReturnPathRequest,CreateEmailReturnPathResponse> handler) Creates a new email return path.
Future<CreateSenderResponse>	createSender(CreateSenderRequest request, AsyncHandler<CreateSenderRequest,CreateSenderResponse> handler) Creates a sender for a tenancy in a given compartment.
Future<CreateSuppressionResponse>	createSuppression(CreateSuppressionRequest request, AsyncHandler<CreateSuppressionRequest,CreateSuppressionResponse> handler) Adds recipient email addresses to the suppression list for a tenancy.
Future<DeleteDkimResponse>	deleteDkim(DeleteDkimRequest request, AsyncHandler<DeleteDkimRequest,DeleteDkimResponse> handler) Deletes a DKIM.
Future<DeleteEmailDomainResponse>	deleteEmailDomain(DeleteEmailDomainRequest request, AsyncHandler<DeleteEmailDomainRequest,DeleteEmailDomainResponse> handler) Deletes an email domain.
Future<DeleteEmailReturnPathResponse>	deleteEmailReturnPath(DeleteEmailReturnPathRequest request, AsyncHandler<DeleteEmailReturnPathRequest,DeleteEmailReturnPathResponse> handler) Deletes an email return path.
Future<DeleteSenderResponse>	deleteSender(DeleteSenderRequest request, AsyncHandler<DeleteSenderRequest,DeleteSenderResponse> handler) Deletes an approved sender for a tenancy in a given compartment for a provided senderId.
Future<DeleteSuppressionResponse>	deleteSuppression(DeleteSuppressionRequest request, AsyncHandler<DeleteSuppressionRequest,DeleteSuppressionResponse> handler) Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided suppressionId.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
Future<GetDkimResponse>	getDkim(GetDkimRequest request, AsyncHandler<GetDkimRequest,GetDkimResponse> handler) Retrieves the specified DKIM.
Future<GetEmailConfigurationResponse>	getEmailConfiguration(GetEmailConfigurationRequest request, AsyncHandler<GetEmailConfigurationRequest,GetEmailConfigurationResponse> handler) Returns email configuration associated with the specified compartment.
Future<GetEmailDomainResponse>	getEmailDomain(GetEmailDomainRequest request, AsyncHandler<GetEmailDomainRequest,GetEmailDomainResponse> handler) Retrieves the specified email domain.
Future<GetEmailReturnPathResponse>	getEmailReturnPath(GetEmailReturnPathRequest request, AsyncHandler<GetEmailReturnPathRequest,GetEmailReturnPathResponse> handler) Retrieves the specified email return path.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetSenderResponse>	getSender(GetSenderRequest request, AsyncHandler<GetSenderRequest,GetSenderResponse> handler) Gets an approved sender for a given senderId.
Future<GetSuppressionResponse>	getSuppression(GetSuppressionRequest request, AsyncHandler<GetSuppressionRequest,GetSuppressionResponse> handler) Gets the details of a suppressed recipient email address for a given suppressionId.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListDkimsResponse>	listDkims(ListDkimsRequest request, AsyncHandler<ListDkimsRequest,ListDkimsResponse> handler) Lists DKIMs for an email domain.
Future<ListEmailDomainsResponse>	listEmailDomains(ListEmailDomainsRequest request, AsyncHandler<ListEmailDomainsRequest,ListEmailDomainsResponse> handler) Lists email domains in the specified compartment.
Future<ListEmailReturnPathsResponse>	listEmailReturnPaths(ListEmailReturnPathsRequest request, AsyncHandler<ListEmailReturnPathsRequest,ListEmailReturnPathsResponse> handler) Lists email return paths in the specified compartment or emaildomain.
Future<ListSendersResponse>	listSenders(ListSendersRequest request, AsyncHandler<ListSendersRequest,ListSendersResponse> handler) Gets a collection of approved sender email addresses and sender IDs.
Future<ListSuppressionsResponse>	listSuppressions(ListSuppressionsRequest request, AsyncHandler<ListSuppressionsRequest,ListSuppressionsResponse> handler) Gets a list of suppressed recipient email addresses for a user.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a 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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateDkimResponse>	updateDkim(UpdateDkimRequest request, AsyncHandler<UpdateDkimRequest,UpdateDkimResponse> handler) Modifies a DKIM.
Future<UpdateEmailDomainResponse>	updateEmailDomain(UpdateEmailDomainRequest request, AsyncHandler<UpdateEmailDomainRequest,UpdateEmailDomainResponse> handler) Modifies an email domain.
Future<UpdateEmailReturnPathResponse>	updateEmailReturnPath(UpdateEmailReturnPathRequest request, AsyncHandler<UpdateEmailReturnPathRequest,UpdateEmailReturnPathResponse> handler) Modifies an email return path.
Future<UpdateSenderResponse>	updateSender(UpdateSenderRequest request, AsyncHandler<UpdateSenderRequest,UpdateSenderResponse> handler) Replaces the set of tags for a sender with the tags provided.
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.email.EmailAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Email.

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

EmailAsyncClient

@Deprecated
public EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

EmailAsyncClient

@Deprecated
public EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

EmailAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

EmailAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

EmailAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

EmailAsyncClient

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

EmailAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: EmailAsync

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 EmailAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: EmailAsync

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 EmailAsync

Parameters:

regionId - The public region ID.

changeEmailDomainCompartment

public Future<ChangeEmailDomainCompartmentResponse> changeEmailDomainCompartment(ChangeEmailDomainCompartmentRequest request,
                                                                                 AsyncHandler<ChangeEmailDomainCompartmentRequest,ChangeEmailDomainCompartmentResponse> handler)

Description copied from interface: EmailAsync

Moves an email domain into a different compartment. When provided, If-Match is checked against ETag value of the resource. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

*Note:** All DKIM objects associated with this email domain will also be moved into the provided compartment.

Specified by:

changeEmailDomainCompartment in interface EmailAsync

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.

changeSenderCompartment

public Future<ChangeSenderCompartmentResponse> changeSenderCompartment(ChangeSenderCompartmentRequest request,
                                                                       AsyncHandler<ChangeSenderCompartmentRequest,ChangeSenderCompartmentResponse> handler)

Description copied from interface: EmailAsync

Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeSenderCompartment in interface EmailAsync

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.

createDkim

public Future<CreateDkimResponse> createDkim(CreateDkimRequest request,
                                             AsyncHandler<CreateDkimRequest,CreateDkimResponse> handler)

Description copied from interface: EmailAsync

Creates a new DKIM for an email domain. This DKIM signs all approved senders in the tenancy that are in this email domain. Best security practices indicate to periodically rotate the DKIM that is doing the signing. When a second DKIM is applied, all senders seamlessly pick up the new key without interruption in signing.

Specified by:

createDkim in interface EmailAsync

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.

createEmailDomain

public Future<CreateEmailDomainResponse> createEmailDomain(CreateEmailDomainRequest request,
                                                           AsyncHandler<CreateEmailDomainRequest,CreateEmailDomainResponse> handler)

Description copied from interface: EmailAsync

Creates a new email domain. Avoid entering confidential information.

Specified by:

createEmailDomain in interface EmailAsync

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.

createEmailReturnPath

public Future<CreateEmailReturnPathResponse> createEmailReturnPath(CreateEmailReturnPathRequest request,
                                                                   AsyncHandler<CreateEmailReturnPathRequest,CreateEmailReturnPathResponse> handler)

Description copied from interface: EmailAsync

Creates a new email return path. Avoid entering confidential information.

Specified by:

createEmailReturnPath in interface EmailAsync

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.

createSender

public Future<CreateSenderResponse> createSender(CreateSenderRequest request,
                                                 AsyncHandler<CreateSenderRequest,CreateSenderResponse> handler)

Description copied from interface: EmailAsync

Creates a sender for a tenancy in a given compartment.

Specified by:

createSender in interface EmailAsync

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.

createSuppression

public Future<CreateSuppressionResponse> createSuppression(CreateSuppressionRequest request,
                                                           AsyncHandler<CreateSuppressionRequest,CreateSuppressionResponse> handler)

Description copied from interface: EmailAsync

Adds recipient email addresses to the suppression list for a tenancy. Addresses added to the suppression list via the API are denoted as "MANUAL" in the reason field. Note: All email addresses added to the suppression list are normalized to include only lowercase letters.

Specified by:

createSuppression in interface EmailAsync

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.

deleteDkim

public Future<DeleteDkimResponse> deleteDkim(DeleteDkimRequest request,
                                             AsyncHandler<DeleteDkimRequest,DeleteDkimResponse> handler)

Description copied from interface: EmailAsync

Deletes a DKIM. If this key is currently the active key for the email domain, deleting the key will stop signing the domain’s outgoing mail. DKIM keys are left in DELETING state for about a day to allow DKIM signatures on in-transit mail to be validated. Consider creating a new DKIM for this domain so the signing can be rotated to it instead of deletion.

Specified by:

deleteDkim in interface EmailAsync

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.

deleteEmailDomain

public Future<DeleteEmailDomainResponse> deleteEmailDomain(DeleteEmailDomainRequest request,
                                                           AsyncHandler<DeleteEmailDomainRequest,DeleteEmailDomainResponse> handler)

Description copied from interface: EmailAsync

Deletes an email domain.

Specified by:

deleteEmailDomain in interface EmailAsync

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.

deleteEmailReturnPath

public Future<DeleteEmailReturnPathResponse> deleteEmailReturnPath(DeleteEmailReturnPathRequest request,
                                                                   AsyncHandler<DeleteEmailReturnPathRequest,DeleteEmailReturnPathResponse> handler)

Description copied from interface: EmailAsync

Deletes an email return path.

Specified by:

deleteEmailReturnPath in interface EmailAsync

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.

deleteSender

public Future<DeleteSenderResponse> deleteSender(DeleteSenderRequest request,
                                                 AsyncHandler<DeleteSenderRequest,DeleteSenderResponse> handler)

Description copied from interface: EmailAsync

Deletes an approved sender for a tenancy in a given compartment for a provided senderId.

Specified by:

deleteSender in interface EmailAsync

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.

deleteSuppression

public Future<DeleteSuppressionResponse> deleteSuppression(DeleteSuppressionRequest request,
                                                           AsyncHandler<DeleteSuppressionRequest,DeleteSuppressionResponse> handler)

Description copied from interface: EmailAsync

Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided suppressionId.

Specified by:

deleteSuppression in interface EmailAsync

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.

getDkim

public Future<GetDkimResponse> getDkim(GetDkimRequest request,
                                       AsyncHandler<GetDkimRequest,GetDkimResponse> handler)

Description copied from interface: EmailAsync

Retrieves the specified DKIM.

Specified by:

getDkim in interface EmailAsync

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.

getEmailConfiguration

public Future<GetEmailConfigurationResponse> getEmailConfiguration(GetEmailConfigurationRequest request,
                                                                   AsyncHandler<GetEmailConfigurationRequest,GetEmailConfigurationResponse> handler)

Description copied from interface: EmailAsync

Returns email configuration associated with the specified compartment.

Specified by:

getEmailConfiguration in interface EmailAsync

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.

getEmailDomain

public Future<GetEmailDomainResponse> getEmailDomain(GetEmailDomainRequest request,
                                                     AsyncHandler<GetEmailDomainRequest,GetEmailDomainResponse> handler)

Description copied from interface: EmailAsync

Retrieves the specified email domain.

Specified by:

getEmailDomain in interface EmailAsync

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.

getEmailReturnPath

public Future<GetEmailReturnPathResponse> getEmailReturnPath(GetEmailReturnPathRequest request,
                                                             AsyncHandler<GetEmailReturnPathRequest,GetEmailReturnPathResponse> handler)

Description copied from interface: EmailAsync

Retrieves the specified email return path.

Specified by:

getEmailReturnPath in interface EmailAsync

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.

getSender

public Future<GetSenderResponse> getSender(GetSenderRequest request,
                                           AsyncHandler<GetSenderRequest,GetSenderResponse> handler)

Description copied from interface: EmailAsync

Gets an approved sender for a given senderId.

Specified by:

getSender in interface EmailAsync

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.

getSuppression

public Future<GetSuppressionResponse> getSuppression(GetSuppressionRequest request,
                                                     AsyncHandler<GetSuppressionRequest,GetSuppressionResponse> handler)

Description copied from interface: EmailAsync

Gets the details of a suppressed recipient email address for a given suppressionId. Each suppression is given a unique OCID.

Specified by:

getSuppression in interface EmailAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: EmailAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface EmailAsync

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.

listDkims

public Future<ListDkimsResponse> listDkims(ListDkimsRequest request,
                                           AsyncHandler<ListDkimsRequest,ListDkimsResponse> handler)

Description copied from interface: EmailAsync

Lists DKIMs for an email domain.

Specified by:

listDkims in interface EmailAsync

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.

listEmailDomains

public Future<ListEmailDomainsResponse> listEmailDomains(ListEmailDomainsRequest request,
                                                         AsyncHandler<ListEmailDomainsRequest,ListEmailDomainsResponse> handler)

Description copied from interface: EmailAsync

Lists email domains in the specified compartment.

Specified by:

listEmailDomains in interface EmailAsync

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.

listEmailReturnPaths

public Future<ListEmailReturnPathsResponse> listEmailReturnPaths(ListEmailReturnPathsRequest request,
                                                                 AsyncHandler<ListEmailReturnPathsRequest,ListEmailReturnPathsResponse> handler)

Description copied from interface: EmailAsync

Lists email return paths in the specified compartment or emaildomain.

Specified by:

listEmailReturnPaths in interface EmailAsync

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.

listSenders

public Future<ListSendersResponse> listSenders(ListSendersRequest request,
                                               AsyncHandler<ListSendersRequest,ListSendersResponse> handler)

Description copied from interface: EmailAsync

Gets a collection of approved sender email addresses and sender IDs.

Specified by:

listSenders in interface EmailAsync

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.

listSuppressions

public Future<ListSuppressionsResponse> listSuppressions(ListSuppressionsRequest request,
                                                         AsyncHandler<ListSuppressionsRequest,ListSuppressionsResponse> handler)

Description copied from interface: EmailAsync

Gets a list of suppressed recipient email addresses for a user. The compartmentId for suppressions must be a tenancy OCID. The returned list is sorted by creation time in descending order.

Specified by:

listSuppressions in interface EmailAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: EmailAsync

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface EmailAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: EmailAsync

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface EmailAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: EmailAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface EmailAsync

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.

updateDkim

public Future<UpdateDkimResponse> updateDkim(UpdateDkimRequest request,
                                             AsyncHandler<UpdateDkimRequest,UpdateDkimResponse> handler)

Description copied from interface: EmailAsync

Modifies a DKIM.

Specified by:

updateDkim in interface EmailAsync

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.

updateEmailDomain

public Future<UpdateEmailDomainResponse> updateEmailDomain(UpdateEmailDomainRequest request,
                                                           AsyncHandler<UpdateEmailDomainRequest,UpdateEmailDomainResponse> handler)

Description copied from interface: EmailAsync

Modifies an email domain.

Specified by:

updateEmailDomain in interface EmailAsync

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.

updateEmailReturnPath

public Future<UpdateEmailReturnPathResponse> updateEmailReturnPath(UpdateEmailReturnPathRequest request,
                                                                   AsyncHandler<UpdateEmailReturnPathRequest,UpdateEmailReturnPathResponse> handler)

Description copied from interface: EmailAsync

Modifies an email return path.

Specified by:

updateEmailReturnPath in interface EmailAsync

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.

updateSender

public Future<UpdateSenderResponse> updateSender(UpdateSenderRequest request,
                                                 AsyncHandler<UpdateSenderRequest,UpdateSenderResponse> handler)

Description copied from interface: EmailAsync

Replaces the set of tags for a sender with the tags provided. If either freeform or defined tags are omitted, the tags for that set remain the same. Each set must include the full set of tags for the sender, partial updates are not permitted. For more information about tagging, see Resource Tags.

Specified by:

updateSender in interface EmailAsync

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)