@Generated(value="OracleSDKGenerator", comments="API Version: 20170907") public class EmailAsyncClient extends Object implements EmailAsync
Async client implementation for Email service.
There are two ways to use async client:
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. Modifier and Type | Class and Description |
---|---|
static class |
EmailAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Email.
|
Constructor and Description |
---|
EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static EmailAsyncClient.Builder |
builder()
Create a builder for this client.
|
Future<ChangeSenderCompartmentResponse> |
changeSenderCompartment(ChangeSenderCompartmentRequest request,
AsyncHandler<ChangeSenderCompartmentRequest,ChangeSenderCompartmentResponse> handler)
Moves a sender into a different compartment.
|
void |
close() |
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<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 |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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<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.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
Future<UpdateSenderResponse> |
updateSender(UpdateSenderRequest request,
AsyncHandler<UpdateSenderRequest,UpdateSenderResponse> handler)
Replaces the set of tags for a sender with the tags provided.
|
public static final Service SERVICE
Service instance for Email.
public EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public EmailAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public EmailAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static EmailAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
EmailAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface EmailAsync
endpoint
- The endpoint of the serice.public String getEndpoint()
EmailAsync
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface EmailAsync
public void setRegion(Region region)
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.
setRegion
in interface EmailAsync
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface EmailAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<ChangeSenderCompartmentResponse> changeSenderCompartment(ChangeSenderCompartmentRequest request, AsyncHandler<ChangeSenderCompartmentRequest,ChangeSenderCompartmentResponse> handler)
EmailAsync
Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeSenderCompartment
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateSenderResponse> createSender(CreateSenderRequest request, AsyncHandler<CreateSenderRequest,CreateSenderResponse> handler)
EmailAsync
Creates a sender for a tenancy in a given compartment.
createSender
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateSuppressionResponse> createSuppression(CreateSuppressionRequest request, AsyncHandler<CreateSuppressionRequest,CreateSuppressionResponse> handler)
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.
createSuppression
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteSenderResponse> deleteSender(DeleteSenderRequest request, AsyncHandler<DeleteSenderRequest,DeleteSenderResponse> handler)
EmailAsync
Deletes an approved sender for a tenancy in a given compartment for a
provided senderId
.
deleteSender
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteSuppressionResponse> deleteSuppression(DeleteSuppressionRequest request, AsyncHandler<DeleteSuppressionRequest,DeleteSuppressionResponse> handler)
EmailAsync
Removes a suppressed recipient email address from the suppression list
for a tenancy in a given compartment for a provided suppressionId
.
deleteSuppression
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetSenderResponse> getSender(GetSenderRequest request, AsyncHandler<GetSenderRequest,GetSenderResponse> handler)
EmailAsync
Gets an approved sender for a given senderId
.
getSender
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetSuppressionResponse> getSuppression(GetSuppressionRequest request, AsyncHandler<GetSuppressionRequest,GetSuppressionResponse> handler)
EmailAsync
Gets the details of a suppressed recipient email address for a given
suppressionId
. Each suppression is given a unique OCID.
getSuppression
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSendersResponse> listSenders(ListSendersRequest request, AsyncHandler<ListSendersRequest,ListSendersResponse> handler)
EmailAsync
Gets a collection of approved sender email addresses and sender IDs.
listSenders
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSuppressionsResponse> listSuppressions(ListSuppressionsRequest request, AsyncHandler<ListSuppressionsRequest,ListSuppressionsResponse> handler)
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.
listSuppressions
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateSenderResponse> updateSender(UpdateSenderRequest request, AsyncHandler<UpdateSenderRequest,UpdateSenderResponse> handler)
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.
updateSender
in interface EmailAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2021. All rights reserved.