Package com.azure.resourcemanager.eventhubs.models

Class RetentionDescription

java.lang.Object
com.azure.resourcemanager.eventhubs.models.RetentionDescription
All Implemented Interfaces:
com.azure.json.JsonSerializable<RetentionDescription>
public final class RetentionDescription extends Object implements com.azure.json.JsonSerializable<RetentionDescription>
Properties to configure retention settings for the eventhub.

  • Constructor Details

    • RetentionDescription

      public RetentionDescription()
      Creates an instance of RetentionDescription class.

  • Method Details

    • cleanupPolicy

      public CleanupPolicyRetentionDescription cleanupPolicy()
      Get the cleanupPolicy property: Enumerates the possible values for cleanup policy.
      Returns:
      the cleanupPolicy value.

    • withCleanupPolicy

      public RetentionDescription withCleanupPolicy(CleanupPolicyRetentionDescription cleanupPolicy)
      Set the cleanupPolicy property: Enumerates the possible values for cleanup policy.
      Parameters:
      cleanupPolicy - the cleanupPolicy value to set.
      Returns:
      the RetentionDescription object itself.

    • retentionTimeInHours

      public Long retentionTimeInHours()
      Get the retentionTimeInHours property: Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue.
      Returns:
      the retentionTimeInHours value.

    • withRetentionTimeInHours

      public RetentionDescription withRetentionTimeInHours(Long retentionTimeInHours)
      Set the retentionTimeInHours property: Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue.
      Parameters:
      retentionTimeInHours - the retentionTimeInHours value to set.
      Returns:
      the RetentionDescription object itself.

    • tombstoneRetentionTimeInHours

      public Integer tombstoneRetentionTimeInHours()
      Get the tombstoneRetentionTimeInHours property: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub.
      Returns:
      the tombstoneRetentionTimeInHours value.

    • withTombstoneRetentionTimeInHours

      public RetentionDescription withTombstoneRetentionTimeInHours(Integer tombstoneRetentionTimeInHours)
      Set the tombstoneRetentionTimeInHours property: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub.
      Parameters:
      tombstoneRetentionTimeInHours - the tombstoneRetentionTimeInHours value to set.
      Returns:
      the RetentionDescription object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RetentionDescription>
      Throws:
      IOException

    • fromJson

      public static RetentionDescription fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RetentionDescription from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RetentionDescription 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 RetentionDescription.