Package com.commercetools.api.models.subscription
package com.commercetools.api.models.subscription
-
ClassDescriptionDefines the method of authentication for AWS SQS and SNS Destinations.possible values of AwsAuthenticationModeAzure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.AzureEventGridDestinationBuilder Example to create an instance using the builder patternAzure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.Azure Service Bus can be used as a pull-queue with Queues, or to fan-out messages with Topics and Subscriptions.AzureServiceBusDestinationBuilder Example to create an instance using the builder patternAzure Service Bus can be used as a pull-queue with Queues, or to fan-out messages with Topics and Subscriptions.Notification about changes to a resource.ChangeSubscriptionBuilder Example to create an instance using the builder patternNotification about changes to a resource.Resource types supported by ChangeSubscriptions:possible values of ChangeSubscriptionResourceTypeIdThe CloudEventsFormat can be used with any Destination, and the payload is delivered in the
JSON Event Format
.CloudEventsFormatBuilder Example to create an instance using the builder patternThe CloudEventsFormat can be used with any Destination, and the payload is delivered in theJSON Event Format
.The CloudEventsFormat represents event data in a way that conforms to a common specification.CloudEventsPayloadBuilder Example to create an instance using the builder patternThe CloudEventsFormat represents event data in a way that conforms to a common specification.This destination can be used to push events and messages to Confluent Cloud.ConfluentCloudDestinationBuilder Example to create an instance using the builder patternThis destination can be used to push events and messages to Confluent Cloud.Deprecated.Deprecated.useCloudEventsFormatBuilder
insteadDeliveryFormat Example to create a subtype instance using the builder patternDeliveryFormatBuilderDeliveryFormatAll payloads for the PlatformFormat share these common fields.DeliveryPayloadBuilderAll payloads for the PlatformFormat share these common fields.Deprecated.usePlatformFormat
insteadDeprecated.usePlatformFormatBuilder
insteadDestination Example to create a subtype instance using the builder patternDestinationBuilderDestinationAWS EventBridge can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules.EventBridgeDestinationBuilder Example to create an instance using the builder patternAWS EventBridge can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules.Destination for Google Cloud Pub/Sub that can be used for Pull subscriptions as well as for Push subscriptions.GoogleCloudPubSubDestinationBuilder Example to create an instance using the builder patternDestination for Google Cloud Pub/Sub that can be used for Pull subscriptions as well as for Push subscriptions.Deprecated.useMessageDeliveryPayload
insteadDeprecated.useMessageDeliveryPayloadBuilder
insteadThis payload is sent for a MessageSubscription.MessageDeliveryPayloadBuilder Example to create an instance using the builder patternThis payload is sent for a MessageSubscription.For supported resources and message types, see Message Types.MessageSubscriptionBuilder Example to create an instance using the builder patternFor supported resources and message types, see Message Types.Resource types supported by MessageSubscriptions:possible values of MessageSubscriptionResourceTypeIdPayloadNotIncluded Example to create an instance using the builder patternPayloadNotIncludedBuilder Example to create an instance using the builder patternPayloadNotIncludedThe PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.PlatformFormatBuilder Example to create an instance using the builder patternThe PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.Deprecated.useResourceCreatedDeliveryPayload
insteadDeprecated.useResourceCreatedDeliveryPayloadBuilder
insteadThis payload is sent for a ChangeSubscription when a resource is created.ResourceCreatedDeliveryPayloadBuilder Example to create an instance using the builder patternThis payload is sent for a ChangeSubscription when a resource is created.Deprecated.useResourceDeletedDeliveryPayload
insteadDeprecated.useResourceDeletedDeliveryPayloadBuilder
insteadThis payload is sent for a ChangeSubscription when a resource is deleted.ResourceDeletedDeliveryPayloadBuilder Example to create an instance using the builder patternThis payload is sent for a ChangeSubscription when a resource is deleted.Deprecated.useResourceUpdatedDeliveryPayload
insteadDeprecated.useResourceUpdatedDeliveryPayloadBuilder
insteadThis payload is sent for a ChangeSubscription when a resource is updated.ResourceUpdatedDeliveryPayloadBuilder Example to create an instance using the builder patternThis payload is sent for a ChangeSubscription when a resource is updated.AWS SNS can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.SnsDestinationBuilder Example to create an instance using the builder patternAWS SNS can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.AWS SQS is a pull-queue on AWS.SqsDestinationBuilder Example to create an instance using the builder patternAWS SQS is a pull-queue on AWS.Subscription Example to create an instance using the builder patternSubscriptionBuilder Example to create an instance using the builder patternA test message is sent to ensure the correct configuration of the Destination.SubscriptionChangeDestinationActionBuilder Example to create an instance using the builder patternA test message is sent to ensure the correct configuration of the Destination.Deprecated.useDeliveryPayload
insteadEithermessages
orchanges
must be set.SubscriptionDraftBuilder Example to create an instance using the builder patternEithermessages
orchanges
must be set.The health status of the Subscription that indicates whether messages are being delivered to the Destination.possible values of SubscriptionHealthStatusSubscriptionPagedQueryResult withresults
containing an array of Subscription.SubscriptionPagedQueryResponseBuilder Example to create an instance using the builder patternPagedQueryResult withresults
containing an array of Subscription.SubscriptionSetChangesAction Example to create an instance using the builder patternSubscriptionSetChangesActionBuilder Example to create an instance using the builder patternSubscriptionSetChangesActionSubscriptionSetKeyAction Example to create an instance using the builder patternSubscriptionSetKeyActionBuilder Example to create an instance using the builder patternSubscriptionSetKeyActionSubscriptionSetMessagesAction Example to create an instance using the builder patternSubscriptionSetMessagesActionBuilder Example to create an instance using the builder patternSubscriptionSetMessagesActionSubscriptionUpdate Example to create an instance using the builder patternSubscriptionUpdateAction Example to create a subtype instance using the builder patternSubscriptionUpdateActionBuilderSubscriptionUpdateActionSubscriptionUpdateBuilder Example to create an instance using the builder patternSubscriptionUpdate
CloudEventsFormat
instead