@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class NotificationDataPlaneClient extends Object implements NotificationDataPlane
Modifier and Type | Class and Description |
---|---|
static class |
NotificationDataPlaneClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for NotificationDataPlane.
|
Modifier | Constructor and Description |
---|---|
|
NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NotificationDataPlaneClient(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.
|
|
NotificationDataPlaneClient(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.
|
|
NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NotificationDataPlaneClient(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 NotificationDataPlaneClient.Builder |
builder()
Create a builder for this client.
|
ChangeSubscriptionCompartmentResponse |
changeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest request)
Moves a subscription into a different compartment within the same tenancy.
|
void |
close() |
CreateSubscriptionResponse |
createSubscription(CreateSubscriptionRequest request)
Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint.
|
DeleteSubscriptionResponse |
deleteSubscription(DeleteSubscriptionRequest request)
Deletes the specified subscription.
|
GetConfirmSubscriptionResponse |
getConfirmSubscription(GetConfirmSubscriptionRequest request)
Gets the confirmation details for the specified subscription.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
NotificationDataPlanePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
GetSubscriptionResponse |
getSubscription(GetSubscriptionRequest request)
Gets the specified subscription’s configuration information.
|
GetUnsubscriptionResponse |
getUnsubscription(GetUnsubscriptionRequest request)
Unsubscribes the subscription from the topic.
|
NotificationDataPlaneWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListSubscriptionsResponse |
listSubscriptions(ListSubscriptionsRequest request)
Lists the subscriptions in the specified compartment or topic.
|
PublishMessageResponse |
publishMessage(PublishMessageRequest request)
Publishes a message to the specified topic.
|
ResendSubscriptionConfirmationResponse |
resendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest request)
Resends the confirmation details for the specified subscription.
|
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’).
|
UpdateSubscriptionResponse |
updateSubscription(UpdateSubscriptionRequest request)
Updates the specified subscription’s configuration.
|
public static final Service SERVICE
Service instance for NotificationDataPlane.
public NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public NotificationDataPlaneClient(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 NotificationDataPlaneClient(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 NotificationDataPlaneClient(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 NotificationDataPlaneClient(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 NotificationDataPlaneClient(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 NotificationDataPlaneClient(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 NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, 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.
Use the NotificationDataPlaneClient.Builder
to get access to all these parameters.
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static NotificationDataPlaneClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
NotificationDataPlane
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface NotificationDataPlane
endpoint
- The endpoint of the service.public String getEndpoint()
NotificationDataPlane
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface NotificationDataPlane
public void setRegion(Region region)
NotificationDataPlane
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 NotificationDataPlane
region
- The region of the service.public void setRegion(String regionId)
NotificationDataPlane
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 NotificationDataPlane
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public ChangeSubscriptionCompartmentResponse changeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest request)
NotificationDataPlane
Moves a subscription into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
changeSubscriptionCompartment
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest request)
NotificationDataPlane
Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in "Pending" status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
createSubscription
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic DeleteSubscriptionResponse deleteSubscription(DeleteSubscriptionRequest request)
NotificationDataPlane
Deletes the specified subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
deleteSubscription
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic GetConfirmSubscriptionResponse getConfirmSubscription(GetConfirmSubscriptionRequest request)
NotificationDataPlane
Gets the confirmation details for the specified subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
getConfirmSubscription
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic GetSubscriptionResponse getSubscription(GetSubscriptionRequest request)
NotificationDataPlane
Gets the specified subscription’s configuration information.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
getSubscription
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic GetUnsubscriptionResponse getUnsubscription(GetUnsubscriptionRequest request)
NotificationDataPlane
Unsubscribes the subscription from the topic.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
getUnsubscription
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)
NotificationDataPlane
Lists the subscriptions in the specified compartment or topic.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
listSubscriptions
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic PublishMessageResponse publishMessage(PublishMessageRequest request)
NotificationDataPlane
Publishes a message to the specified topic.
The topic endpoint is required for this operation.
To get the topic endpoint, use getTopic
and review the `apiEndpoint` value in the response (NotificationTopic
).
Limits information follows.
Message size limit per request: 64KB.
Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol. HTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)
For more information about publishing messages, see [Publishing Messages](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm). For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).
publishMessage
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic ResendSubscriptionConfirmationResponse resendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest request)
NotificationDataPlane
Resends the confirmation details for the specified subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
resendSubscriptionConfirmation
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic UpdateSubscriptionResponse updateSubscription(UpdateSubscriptionRequest request)
NotificationDataPlane
Updates the specified subscription’s configuration.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
updateSubscription
in interface NotificationDataPlane
request
- The request object containing the details to sendpublic NotificationDataPlaneWaiters getWaiters()
NotificationDataPlane
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface NotificationDataPlane
public NotificationDataPlanePaginators getPaginators()
NotificationDataPlane
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
getPaginators
in interface NotificationDataPlane
Copyright © 2016–2022. All rights reserved.