WebhookEventSubscriptionDestination Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.models.EventSubscriptionDestination
  • • com.azure.resourcemanager.eventgrid.models.WebhookEventSubscriptionDestination

public final class WebhookEventSubscriptionDestination
extends EventSubscriptionDestination

Information about the webhook destination for an event subscription.

Constructor Summary

Constructor	Description
WebhookEventSubscriptionDestination()	Creates an instance of WebhookEventSubscriptionDestination class.

Method Summary

Modifier and Type	Method and Description
String	azureActiveDirectoryApplicationIdOrUri() Get the azureActiveDirectoryApplicationIdOrUri property: The Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
String	azureActiveDirectoryTenantId() Get the azureActiveDirectoryTenantId property: The Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.
List<DeliveryAttributeMapping>	deliveryAttributeMappings() Get the deliveryAttributeMappings property: Delivery attribute details.
String	endpointBaseUrl() Get the endpointBaseUrl property: The base URL that represents the endpoint of the destination of an event subscription.
EndpointType	endpointType() Get the endpointType property: Type of the endpoint for the event subscription destination.
String	endpointUrl() Get the endpointUrl property: The URL that represents the endpoint of the destination of an event subscription.
static WebhookEventSubscriptionDestination	fromJson(JsonReader jsonReader) Reads an instance of WebhookEventSubscriptionDestination from the JsonReader.
Integer	maxEventsPerBatch() Get the maxEventsPerBatch property: Maximum number of events per batch.
TlsVersion	minimumTlsVersionAllowed() Get the minimumTlsVersionAllowed property: Minimum TLS version that should be supported by webhook endpoint.
Integer	preferredBatchSizeInKilobytes() Get the preferredBatchSizeInKilobytes property: Preferred batch size in Kilobytes.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
WebhookEventSubscriptionDestination	withAzureActiveDirectoryApplicationIdOrUri(String azureActiveDirectoryApplicationIdOrUri) Set the azureActiveDirectoryApplicationIdOrUri property: The Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.
WebhookEventSubscriptionDestination	withAzureActiveDirectoryTenantId(String azureActiveDirectoryTenantId) Set the azureActiveDirectoryTenantId property: The Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.
WebhookEventSubscriptionDestination	withDeliveryAttributeMappings(List<DeliveryAttributeMapping> deliveryAttributeMappings) Set the deliveryAttributeMappings property: Delivery attribute details.
WebhookEventSubscriptionDestination	withEndpointUrl(String endpointUrl) Set the endpointUrl property: The URL that represents the endpoint of the destination of an event subscription.
WebhookEventSubscriptionDestination	withMaxEventsPerBatch(Integer maxEventsPerBatch) Set the maxEventsPerBatch property: Maximum number of events per batch.
WebhookEventSubscriptionDestination	withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed) Set the minimumTlsVersionAllowed property: Minimum TLS version that should be supported by webhook endpoint.
WebhookEventSubscriptionDestination	withPreferredBatchSizeInKilobytes(Integer preferredBatchSizeInKilobytes) Set the preferredBatchSizeInKilobytes property: Preferred batch size in Kilobytes.

Methods inherited from EventSubscriptionDestination

endpointType fromJson toJson validate

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

WebhookEventSubscriptionDestination

public WebhookEventSubscriptionDestination()

Creates an instance of WebhookEventSubscriptionDestination class.

Method Details

azureActiveDirectoryApplicationIdOrUri

public String azureActiveDirectoryApplicationIdOrUri()

Get the azureActiveDirectoryApplicationIdOrUri property: The Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

Returns:

the azureActiveDirectoryApplicationIdOrUri value.

azureActiveDirectoryTenantId

public String azureActiveDirectoryTenantId()

Get the azureActiveDirectoryTenantId property: The Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.

Returns:

the azureActiveDirectoryTenantId value.

deliveryAttributeMappings

public List<DeliveryAttributeMapping> deliveryAttributeMappings()

Get the deliveryAttributeMappings property: Delivery attribute details.

Returns:

the deliveryAttributeMappings value.

endpointBaseUrl

public String endpointBaseUrl()

Get the endpointBaseUrl property: The base URL that represents the endpoint of the destination of an event subscription.

Returns:

the endpointBaseUrl value.

endpointType

public EndpointType endpointType()

Get the endpointType property: Type of the endpoint for the event subscription destination.

Overrides:

WebhookEventSubscriptionDestination.endpointType()

Returns:

the endpointType value.

endpointUrl

public String endpointUrl()

Get the endpointUrl property: The URL that represents the endpoint of the destination of an event subscription.

Returns:

the endpointUrl value.

fromJson

public static WebhookEventSubscriptionDestination fromJson(JsonReader jsonReader)

Reads an instance of WebhookEventSubscriptionDestination from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WebhookEventSubscriptionDestination if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the WebhookEventSubscriptionDestination.

maxEventsPerBatch

public Integer maxEventsPerBatch()

Get the maxEventsPerBatch property: Maximum number of events per batch.

Returns:

the maxEventsPerBatch value.

minimumTlsVersionAllowed

public TlsVersion minimumTlsVersionAllowed()

Get the minimumTlsVersionAllowed property: Minimum TLS version that should be supported by webhook endpoint.

Returns:

the minimumTlsVersionAllowed value.

preferredBatchSizeInKilobytes

public Integer preferredBatchSizeInKilobytes()

Get the preferredBatchSizeInKilobytes property: Preferred batch size in Kilobytes.

Returns:

the preferredBatchSizeInKilobytes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

WebhookEventSubscriptionDestination.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

Overrides:

WebhookEventSubscriptionDestination.validate()

withAzureActiveDirectoryApplicationIdOrUri

public WebhookEventSubscriptionDestination withAzureActiveDirectoryApplicationIdOrUri(String azureActiveDirectoryApplicationIdOrUri)

Set the azureActiveDirectoryApplicationIdOrUri property: The Microsoft Entra ID Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

Parameters:

azureActiveDirectoryApplicationIdOrUri - the azureActiveDirectoryApplicationIdOrUri value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.

withAzureActiveDirectoryTenantId

public WebhookEventSubscriptionDestination withAzureActiveDirectoryTenantId(String azureActiveDirectoryTenantId)

Set the azureActiveDirectoryTenantId property: The Microsoft Entra ID Tenant ID to get the access token that will be included as the bearer token in delivery requests.

Parameters:

azureActiveDirectoryTenantId - the azureActiveDirectoryTenantId value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.

withDeliveryAttributeMappings

public WebhookEventSubscriptionDestination withDeliveryAttributeMappings(List<DeliveryAttributeMapping> deliveryAttributeMappings)

Set the deliveryAttributeMappings property: Delivery attribute details.

Parameters:

deliveryAttributeMappings - the deliveryAttributeMappings value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.

withEndpointUrl

public WebhookEventSubscriptionDestination withEndpointUrl(String endpointUrl)

Set the endpointUrl property: The URL that represents the endpoint of the destination of an event subscription.

Parameters:

endpointUrl - the endpointUrl value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.

withMaxEventsPerBatch

public WebhookEventSubscriptionDestination withMaxEventsPerBatch(Integer maxEventsPerBatch)

Set the maxEventsPerBatch property: Maximum number of events per batch.

Parameters:

maxEventsPerBatch - the maxEventsPerBatch value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.

withMinimumTlsVersionAllowed

public WebhookEventSubscriptionDestination withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed)

Set the minimumTlsVersionAllowed property: Minimum TLS version that should be supported by webhook endpoint.

Parameters:

minimumTlsVersionAllowed - the minimumTlsVersionAllowed value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.

withPreferredBatchSizeInKilobytes

public WebhookEventSubscriptionDestination withPreferredBatchSizeInKilobytes(Integer preferredBatchSizeInKilobytes)

Set the preferredBatchSizeInKilobytes property: Preferred batch size in Kilobytes.

Parameters:

preferredBatchSizeInKilobytes - the preferredBatchSizeInKilobytes value to set.

Returns:

the WebhookEventSubscriptionDestination object itself.