NotificationDataPlaneClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.ons.NotificationDataPlaneClient

All Implemented Interfaces:: NotificationDataPlane, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class NotificationDataPlaneClient
extends Object
implements NotificationDataPlane

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NotificationDataPlaneClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NotificationDataPlaneClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for NotificationDataPlane.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for NotificationDataPlane.

Constructor Summary

Constructors
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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for NotificationDataPlane.
- Constructor Detail
  - NotificationDataPlaneClient
```
public NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - NotificationDataPlaneClient
```
public NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - NotificationDataPlaneClient
```
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.
    
    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.
  - NotificationDataPlaneClient
```
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.
    
    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.
  - NotificationDataPlaneClient
```
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.
    
    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.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - NotificationDataPlaneClient
```
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.
    
    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.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - NotificationDataPlaneClient
```
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.
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - NotificationDataPlaneClient
```
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.
    
    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 signer
    
    additionalClientConfigurators - 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 ThreadPoolExecutor
  - NotificationDataPlaneClient
```
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. 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.
    
    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 signer
    
    additionalClientConfigurators - 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 ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static NotificationDataPlaneClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: NotificationDataPlane
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface NotificationDataPlane
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: NotificationDataPlane
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface NotificationDataPlane
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setRegion in interface NotificationDataPlane
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: 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.
    
    Specified by:
    
    setRegion in interface NotificationDataPlane
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - changeSubscriptionCompartment
```
public ChangeSubscriptionCompartmentResponse changeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    changeSubscriptionCompartment in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSubscription
```
public CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    createSubscription in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteSubscription
```
public DeleteSubscriptionResponse deleteSubscription(DeleteSubscriptionRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Deletes the specified subscription.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    deleteSubscription in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getConfirmSubscription
```
public GetConfirmSubscriptionResponse getConfirmSubscription(GetConfirmSubscriptionRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Gets the confirmation details for the specified subscription.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    getConfirmSubscription in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSubscription
```
public GetSubscriptionResponse getSubscription(GetSubscriptionRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Gets the specified subscription’s configuration information.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    getSubscription in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getUnsubscription
```
public GetUnsubscriptionResponse getUnsubscription(GetUnsubscriptionRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Unsubscribes the subscription from the topic.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    getUnsubscription in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSubscriptions
```
public ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Lists the subscriptions in the specified compartment or topic.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    listSubscriptions in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - publishMessage
```
public PublishMessageResponse publishMessage(PublishMessageRequest request)
```
    Description copied from interface: 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).
    
    Specified by:
    
    publishMessage in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - resendSubscriptionConfirmation
```
public ResendSubscriptionConfirmationResponse resendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Resends the confirmation details for the specified subscription.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    resendSubscriptionConfirmation in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateSubscription
```
public UpdateSubscriptionResponse updateSubscription(UpdateSubscriptionRequest request)
```
    Description copied from interface: NotificationDataPlane
    
    Updates the specified subscription’s configuration.
    
    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
    
    Specified by:
    
    updateSubscription in interface NotificationDataPlane
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public NotificationDataPlaneWaiters getWaiters()
```
    Description copied from interface: NotificationDataPlane
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface NotificationDataPlane
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public NotificationDataPlanePaginators getPaginators()
```
    Description copied from interface: 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.
    
    Specified by:
    
    getPaginators in interface NotificationDataPlane
    
    Returns:
    
    The service paginators.

Class NotificationDataPlaneClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

NotificationDataPlaneClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

changeSubscriptionCompartment

createSubscription

deleteSubscription

getConfirmSubscription

getSubscription

getUnsubscription

listSubscriptions

publishMessage

resendSubscriptionConfirmation

updateSubscription

getWaiters

getPaginators