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 classNotificationDataPlaneClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for NotificationDataPlane.
-
Constructor Summary
Constructors Constructor Description NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.NotificationDataPlaneClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NotificationDataPlaneClient.Builderbuilder()Create a builder for this client.ChangeSubscriptionCompartmentResponsechangeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest request)Moves a subscription into a different compartment within the same tenancy.voidclose()CreateSubscriptionResponsecreateSubscription(CreateSubscriptionRequest request)Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint.DeleteSubscriptionResponsedeleteSubscription(DeleteSubscriptionRequest request)Deletes the specified subscription.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()GetConfirmSubscriptionResponsegetConfirmSubscription(GetConfirmSubscriptionRequest request)Gets the confirmation details for the specified subscription.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.NotificationDataPlanePaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.GetSubscriptionResponsegetSubscription(GetSubscriptionRequest request)Gets the specified subscription’s configuration information.GetUnsubscriptionResponsegetUnsubscription(GetUnsubscriptionRequest request)Unsubscribes the subscription from the topic.NotificationDataPlaneWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListSubscriptionsResponselistSubscriptions(ListSubscriptionsRequest request)Lists the subscriptions in the specified compartment or topic.PublishMessageResponsepublishMessage(PublishMessageRequest request)Publishes a message to the specified topic.voidrefreshClient()Rebuild the backingHttpClient.ResendSubscriptionConfirmationResponseresendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest request)Resends the confirmation details for the specified subscription.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateSubscriptionResponseupdateSubscription(UpdateSubscriptionRequest request)Updates the specified subscription’s configuration.voiduseRealmSpecificEndpointTemplate(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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
NotificationDataPlaneClient
@Deprecated public NotificationDataPlaneClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeNotificationDataPlaneClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:NotificationDataPlaneSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceNotificationDataPlane- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:NotificationDataPlaneSets 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:
setRegionin interfaceNotificationDataPlane- Parameters:
regionId- The public region ID.
-
changeSubscriptionCompartment
public ChangeSubscriptionCompartmentResponse changeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest request)
Description copied from interface:NotificationDataPlaneMoves 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:
changeSubscriptionCompartmentin 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:NotificationDataPlaneCreates 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:
createSubscriptionin 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:NotificationDataPlaneDeletes the specified subscription.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
deleteSubscriptionin 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:NotificationDataPlaneGets the confirmation details for the specified subscription.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
getConfirmSubscriptionin 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:NotificationDataPlaneGets the specified subscription’s configuration information.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
getSubscriptionin 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:NotificationDataPlaneUnsubscribes the subscription from the topic.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
getUnsubscriptionin 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:NotificationDataPlaneLists the subscriptions in the specified compartment or topic.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
listSubscriptionsin 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:NotificationDataPlanePublishes a message to the specified topic.The topic endpoint is required for this operation. To get the topic endpoint, use
getTopicand 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:
publishMessagein 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:NotificationDataPlaneResends the confirmation details for the specified subscription.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
resendSubscriptionConfirmationin 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:NotificationDataPlaneUpdates the specified subscription’s configuration.Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
- Specified by:
updateSubscriptionin 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:NotificationDataPlaneGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceNotificationDataPlane- Returns:
- The service waiters.
-
getPaginators
public NotificationDataPlanePaginators getPaginators()
Description copied from interface:NotificationDataPlaneGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceNotificationDataPlane- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-