Class CaptureDescription


  • public final class CaptureDescription
    extends Object
    Properties to configure capture description for eventhub.
    • Constructor Detail

      • CaptureDescription

        public CaptureDescription()
    • Method Detail

      • enabled

        public Boolean enabled()
        Get the enabled property: A value that indicates whether capture description is enabled.
        Returns:
        the enabled value.
      • withEnabled

        public CaptureDescription withEnabled​(Boolean enabled)
        Set the enabled property: A value that indicates whether capture description is enabled.
        Parameters:
        enabled - the enabled value to set.
        Returns:
        the CaptureDescription object itself.
      • encoding

        public EncodingCaptureDescription encoding()
        Get the encoding property: Enumerates the possible values for the encoding format of capture description.
        Returns:
        the encoding value.
      • withEncoding

        public CaptureDescription withEncoding​(EncodingCaptureDescription encoding)
        Set the encoding property: Enumerates the possible values for the encoding format of capture description.
        Parameters:
        encoding - the encoding value to set.
        Returns:
        the CaptureDescription object itself.
      • intervalInSeconds

        public Integer intervalInSeconds()
        Get the intervalInSeconds property: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds.
        Returns:
        the intervalInSeconds value.
      • withIntervalInSeconds

        public CaptureDescription withIntervalInSeconds​(Integer intervalInSeconds)
        Set the intervalInSeconds property: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds.
        Parameters:
        intervalInSeconds - the intervalInSeconds value to set.
        Returns:
        the CaptureDescription object itself.
      • sizeLimitInBytes

        public Integer sizeLimitInBytes()
        Get the sizeLimitInBytes property: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes.
        Returns:
        the sizeLimitInBytes value.
      • withSizeLimitInBytes

        public CaptureDescription withSizeLimitInBytes​(Integer sizeLimitInBytes)
        Set the sizeLimitInBytes property: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes.
        Parameters:
        sizeLimitInBytes - the sizeLimitInBytes value to set.
        Returns:
        the CaptureDescription object itself.
      • destination

        public Destination destination()
        Get the destination property: Properties of Destination where capture will be stored. (Storage Account, Blob Names).
        Returns:
        the destination value.
      • withDestination

        public CaptureDescription withDestination​(Destination destination)
        Set the destination property: Properties of Destination where capture will be stored. (Storage Account, Blob Names).
        Parameters:
        destination - the destination value to set.
        Returns:
        the CaptureDescription object itself.
      • validate

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