Share via

CaptureDescription Class

  • Reference
Package:
com.microsoft.azure.management.eventhub
Maven Artifact:
com.microsoft.azure:azure-mgmt-eventhub:1.41.2
  • java.lang.Object
    • com.microsoft.azure.management.eventhub.CaptureDescription

public class CaptureDescription

Properties to configure capture description for eventhub.

Constructor Summary

Constructor Description
CaptureDescription()

Method Summary

Modifier and Type Method and Description
Destination destination()

Get properties of Destination where capture will be stored.
java.lang.Boolean enabled()

Get a value that indicates whether capture description is enabled.
EncodingCaptureDescription encoding()

Get enumerates the possible values for the encoding format of capture description.
java.lang.Integer intervalInSeconds()

Get 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.
java.lang.Integer sizeLimitInBytes()

Get the size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.
java.lang.Boolean skipEmptyArchives()

Get a value that indicates whether to Skip Empty Archives.
CaptureDescription withDestination(Destination destination)

Set properties of Destination where capture will be stored.
CaptureDescription withEnabled(Boolean enabled)

Set a value that indicates whether capture description is enabled.
CaptureDescription withEncoding(EncodingCaptureDescription encoding)

Set enumerates the possible values for the encoding format of capture description.
CaptureDescription withIntervalInSeconds(Integer intervalInSeconds)

Set 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.
CaptureDescription withSizeLimitInBytes(Integer sizeLimitInBytes)

Set the size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.
CaptureDescription withSkipEmptyArchives(Boolean skipEmptyArchives)

Set a value that indicates whether to Skip Empty Archives.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

CaptureDescription

public CaptureDescription()

Method Details

destination

public Destination destination()

Get properties of Destination where capture will be stored. (Storage Account, Blob Names).

Returns:

the destination value

enabled

public Boolean enabled()

Get a value that indicates whether capture description is enabled.

Returns:

the enabled value

encoding

public EncodingCaptureDescription encoding()

Get enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version. Possible values include: 'Avro', 'AvroDeflate'.

Returns:

the encoding value

intervalInSeconds

public Integer intervalInSeconds()

Get 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

sizeLimitInBytes

public Integer sizeLimitInBytes()

Get the size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.

Returns:

the sizeLimitInBytes value

skipEmptyArchives

public Boolean skipEmptyArchives()

Get a value that indicates whether to Skip Empty Archives.

Returns:

the skipEmptyArchives value

withDestination

public CaptureDescription withDestination(Destination destination)

Set properties of Destination where capture will be stored. (Storage Account, Blob Names).

Parameters:

destination - the destination value to set

Returns:

the CaptureDescription object itself.

withEnabled

public CaptureDescription withEnabled(Boolean enabled)

Set a value that indicates whether capture description is enabled.

Parameters:

enabled - the enabled value to set

Returns:

the CaptureDescription object itself.

withEncoding

public CaptureDescription withEncoding(EncodingCaptureDescription encoding)

Set enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version. Possible values include: 'Avro', 'AvroDeflate'.

Parameters:

encoding - the encoding value to set

Returns:

the CaptureDescription object itself.

withIntervalInSeconds

public CaptureDescription withIntervalInSeconds(Integer intervalInSeconds)

Set 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.

withSizeLimitInBytes

public CaptureDescription withSizeLimitInBytes(Integer sizeLimitInBytes)

Set the size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes.

Parameters:

sizeLimitInBytes - the sizeLimitInBytes value to set

Returns:

the CaptureDescription object itself.

withSkipEmptyArchives

public CaptureDescription withSkipEmptyArchives(Boolean skipEmptyArchives)

Set a value that indicates whether to Skip Empty Archives.

Parameters:

skipEmptyArchives - the skipEmptyArchives value to set

Returns:

the CaptureDescription object itself.

Applies to