Class NotificationDataPlaneClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.ons.NotificationDataPlaneClient
-
- All Implemented Interfaces:
NotificationDataPlane
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class NotificationDataPlaneClient extends BaseSyncClient implements NotificationDataPlane
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NotificationDataPlaneClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 NotificationDataPlane.
-
Constructor Summary
Constructors Constructor Description NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.String
getClientCommonLibraryVersion()
GetConfirmSubscriptionResponse
getConfirmSubscription(GetConfirmSubscriptionRequest request)
Gets the confirmation details for the specified subscription.protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.PublishMessageResponse
publishMessage(PublishMessageRequest request)
Publishes a message to the specified topic.void
refreshClient()
Rebuild the backingHttpClient
.ResendSubscriptionConfirmationResponse
resendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest request)
Resends the confirmation details for the specified subscription.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.UpdateSubscriptionResponse
updateSubscription(UpdateSubscriptionRequest request)
Updates the specified subscription’s configuration.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.ons.NotificationDataPlane
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.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)
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.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
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNotificationDataPlaneClient.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
executorService
-NotificationDataPlaneClient.Builder.executorService
-
-
Method Detail
-
builder
public static NotificationDataPlaneClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
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 interfaceNotificationDataPlane
- 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 callsetEndpoint
.- Specified by:
setRegion
in interfaceNotificationDataPlane
- Parameters:
regionId
- The public region ID.
-
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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm). For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).
- Specified by:
publishMessage
in interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- 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 interfaceNotificationDataPlane
- Returns:
- The service paginators.
-
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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-