com.azure.resourcemanager.eventgrid.models.PushInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-eventgrid Show documentation
Show all versions of azure-resourcemanager-eventgrid Show documentation
This package contains Microsoft Azure SDK for EventGrid Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure EventGrid Management Client. Package tag package-2021-10-preview.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.eventgrid.models;
import com.azure.core.annotation.Fluent;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Properties of the destination info for event subscription supporting push.
*/
@Fluent
public final class PushInfo {
/*
* The maximum delivery count of the events.
*/
@JsonProperty(value = "maxDeliveryCount")
private Integer maxDeliveryCount;
/*
* Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published.
* This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where:
* - (n) is replaced by the value of each time element that follows the (n).
* - P is the duration (or Period) designator and is always placed at the beginning of the duration.
* - Y is the year designator, and it follows the value for the number of years.
* - M is the month designator, and it follows the value for the number of months.
* - W is the week designator, and it follows the value for the number of weeks.
* - D is the day designator, and it follows the value for the number of days.
* - T is the time designator, and it precedes the time components.
* - H is the hour designator, and it follows the value for the number of hours.
* - M is the minute designator, and it follows the value for the number of minutes.
* - S is the second designator, and it follows the value for the number of seconds.
* This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined
* by topic’s EventRetentionInDays value. The followings are examples of valid values:
* - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes.
* - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day.
*/
@JsonProperty(value = "eventTimeToLive")
private String eventTimeToLive;
/*
* The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering.
*/
@JsonProperty(value = "deadLetterDestinationWithResourceIdentity")
private DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity;
/*
* Information about the destination where events have to be delivered for the event subscription.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery.
*/
@JsonProperty(value = "deliveryWithResourceIdentity")
private DeliveryWithResourceIdentity deliveryWithResourceIdentity;
/*
* Information about the destination where events have to be delivered for the event subscription.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery.
*/
@JsonProperty(value = "destination")
private EventSubscriptionDestination destination;
/**
* Creates an instance of PushInfo class.
*/
public PushInfo() {
}
/**
* Get the maxDeliveryCount property: The maximum delivery count of the events.
*
* @return the maxDeliveryCount value.
*/
public Integer maxDeliveryCount() {
return this.maxDeliveryCount;
}
/**
* Set the maxDeliveryCount property: The maximum delivery count of the events.
*
* @param maxDeliveryCount the maxDeliveryCount value to set.
* @return the PushInfo object itself.
*/
public PushInfo withMaxDeliveryCount(Integer maxDeliveryCount) {
this.maxDeliveryCount = maxDeliveryCount;
return this;
}
/**
* Get the eventTimeToLive property: Time span duration in ISO 8601 format that determines how long messages are
* available to the subscription from the time the message was published.
* This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where:
* - (n) is replaced by the value of each time element that follows the (n).
* - P is the duration (or Period) designator and is always placed at the beginning of the duration.
* - Y is the year designator, and it follows the value for the number of years.
* - M is the month designator, and it follows the value for the number of months.
* - W is the week designator, and it follows the value for the number of weeks.
* - D is the day designator, and it follows the value for the number of days.
* - T is the time designator, and it precedes the time components.
* - H is the hour designator, and it follows the value for the number of hours.
* - M is the minute designator, and it follows the value for the number of minutes.
* - S is the second designator, and it follows the value for the number of seconds.
* This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where
* its minimum value is 1 minute, and its maximum is determined
* by topic’s EventRetentionInDays value. The followings are examples of valid values:
* - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes.
* - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day.
*
* @return the eventTimeToLive value.
*/
public String eventTimeToLive() {
return this.eventTimeToLive;
}
/**
* Set the eventTimeToLive property: Time span duration in ISO 8601 format that determines how long messages are
* available to the subscription from the time the message was published.
* This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where:
* - (n) is replaced by the value of each time element that follows the (n).
* - P is the duration (or Period) designator and is always placed at the beginning of the duration.
* - Y is the year designator, and it follows the value for the number of years.
* - M is the month designator, and it follows the value for the number of months.
* - W is the week designator, and it follows the value for the number of weeks.
* - D is the day designator, and it follows the value for the number of days.
* - T is the time designator, and it precedes the time components.
* - H is the hour designator, and it follows the value for the number of hours.
* - M is the minute designator, and it follows the value for the number of minutes.
* - S is the second designator, and it follows the value for the number of seconds.
* This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where
* its minimum value is 1 minute, and its maximum is determined
* by topic’s EventRetentionInDays value. The followings are examples of valid values:
* - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes.
* - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day.
*
* @param eventTimeToLive the eventTimeToLive value to set.
* @return the PushInfo object itself.
*/
public PushInfo withEventTimeToLive(String eventTimeToLive) {
this.eventTimeToLive = eventTimeToLive;
return this;
}
/**
* Get the deadLetterDestinationWithResourceIdentity property: The dead letter destination of the event
* subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens
* being used during dead-lettering.
*
* @return the deadLetterDestinationWithResourceIdentity value.
*/
public DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity() {
return this.deadLetterDestinationWithResourceIdentity;
}
/**
* Set the deadLetterDestinationWithResourceIdentity property: The dead letter destination of the event
* subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.
* Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens
* being used during dead-lettering.
*
* @param deadLetterDestinationWithResourceIdentity the deadLetterDestinationWithResourceIdentity value to set.
* @return the PushInfo object itself.
*/
public PushInfo withDeadLetterDestinationWithResourceIdentity(
DeadLetterWithResourceIdentity deadLetterDestinationWithResourceIdentity) {
this.deadLetterDestinationWithResourceIdentity = deadLetterDestinationWithResourceIdentity;
return this;
}
/**
* Get the deliveryWithResourceIdentity property: Information about the destination where events have to be
* delivered for the event subscription.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication
* tokens being used during delivery.
*
* @return the deliveryWithResourceIdentity value.
*/
public DeliveryWithResourceIdentity deliveryWithResourceIdentity() {
return this.deliveryWithResourceIdentity;
}
/**
* Set the deliveryWithResourceIdentity property: Information about the destination where events have to be
* delivered for the event subscription.
* Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication
* tokens being used during delivery.
*
* @param deliveryWithResourceIdentity the deliveryWithResourceIdentity value to set.
* @return the PushInfo object itself.
*/
public PushInfo withDeliveryWithResourceIdentity(DeliveryWithResourceIdentity deliveryWithResourceIdentity) {
this.deliveryWithResourceIdentity = deliveryWithResourceIdentity;
return this;
}
/**
* Get the destination property: Information about the destination where events have to be delivered for the event
* subscription.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery.
*
* @return the destination value.
*/
public EventSubscriptionDestination destination() {
return this.destination;
}
/**
* Set the destination property: Information about the destination where events have to be delivered for the event
* subscription.
* Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery.
*
* @param destination the destination value to set.
* @return the PushInfo object itself.
*/
public PushInfo withDestination(EventSubscriptionDestination destination) {
this.destination = destination;
return this;
}
/**
* Validates the instance.
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
public void validate() {
if (deadLetterDestinationWithResourceIdentity() != null) {
deadLetterDestinationWithResourceIdentity().validate();
}
if (deliveryWithResourceIdentity() != null) {
deliveryWithResourceIdentity().validate();
}
if (destination() != null) {
destination().validate();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy