Share via

CaptureDescription Class

  • Reference
Package:
com.azure.resourcemanager.eventhubs.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-eventhubs:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.eventhubs.models.CaptureDescription

Implements

JsonSerializable<CaptureDescription>

public final class CaptureDescription
implements JsonSerializable<CaptureDescription>

Properties to configure capture description for eventhub.

Constructor Summary

Constructor Description
CaptureDescription()

Creates an instance of CaptureDescription class.

Method Summary

Modifier and Type Method and Description
Destination destination()

Get the destination property: Properties of Destination where capture will be stored.
Boolean enabled()

Get the enabled property: A value that indicates whether capture description is enabled.
EncodingCaptureDescription encoding()

Get the encoding property: Enumerates the possible values for the encoding format of capture description.
static CaptureDescription fromJson(JsonReader jsonReader)

Reads an instance of CaptureDescription from the JsonReader.
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.
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 to 524288000 bytes.
Boolean skipEmptyArchives()

Get the skipEmptyArchives property: A value that indicates whether to Skip Empty Archives.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
CaptureDescription withDestination(Destination destination)

Set the destination property: Properties of Destination where capture will be stored.
CaptureDescription withEnabled(Boolean enabled)

Set the enabled property: A value that indicates whether capture description is enabled.
CaptureDescription withEncoding(EncodingCaptureDescription encoding)

Set the encoding property: Enumerates the possible values for the encoding format of capture description.
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.
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 to 524288000 bytes.
CaptureDescription withSkipEmptyArchives(Boolean skipEmptyArchives)

Set the skipEmptyArchives property: A value that indicates whether to Skip Empty Archives.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CaptureDescription

public CaptureDescription()

Creates an instance of CaptureDescription class.

Method Details

destination

public Destination destination()

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

Returns:

the destination value.

enabled

public Boolean enabled()

Get the enabled property: A value that indicates whether capture description is enabled.

Returns:

the enabled value.

encoding

public EncodingCaptureDescription encoding()

Get the encoding property: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version.

Returns:

the encoding value.

fromJson

public static CaptureDescription fromJson(JsonReader jsonReader)

Reads an instance of CaptureDescription from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CaptureDescription 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 CaptureDescription.

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.

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 to 524288000 bytes.

Returns:

the sizeLimitInBytes value.

skipEmptyArchives

public Boolean skipEmptyArchives()

Get the skipEmptyArchives property: A value that indicates whether to Skip Empty Archives.

Returns:

the skipEmptyArchives value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

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.

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.

withEncoding

public CaptureDescription withEncoding(EncodingCaptureDescription encoding)

Set the encoding property: Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version.

Parameters:

encoding - the encoding value to set.

Returns:

the CaptureDescription object itself.

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.

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 to 524288000 bytes.

Parameters:

sizeLimitInBytes - the sizeLimitInBytes value to set.

Returns:

the CaptureDescription object itself.

withSkipEmptyArchives

public CaptureDescription withSkipEmptyArchives(Boolean skipEmptyArchives)

Set the skipEmptyArchives property: A value that indicates whether to Skip Empty Archives.

Parameters:

skipEmptyArchives - the skipEmptyArchives value to set.

Returns:

the CaptureDescription object itself.

Applies to