Share via

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

Implements

JsonSerializable<Destination>

public final class Destination
implements JsonSerializable<Destination>

Capture storage details for capture description.

Constructor Summary

Constructor Description
Destination()

Creates an instance of Destination class.

Method Summary

Modifier and Type Method and Description
String archiveNameFormat()

Get the archiveNameFormat property: Blob naming convention for archive, e.g.
String blobContainer()

Get the blobContainer property: Blob container Name.
String dataLakeAccountName()

Get the dataLakeAccountName property: The Azure Data Lake Store name for the captured events.
String dataLakeFolderPath()

Get the dataLakeFolderPath property: The destination folder path for the captured events.
UUID dataLakeSubscriptionId()

Get the dataLakeSubscriptionId property: Subscription Id of Azure Data Lake Store.
static Destination fromJson(JsonReader jsonReader)

Reads an instance of Destination from the JsonReader.
CaptureIdentity identity()

Get the identity property: A value that indicates whether capture description is enabled.
String name()

Get the name property: Name for capture destination.
String storageAccountResourceId()

Get the storageAccountResourceId property: Resource id of the storage account to be used to create the blobs.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
Destination withArchiveNameFormat(String archiveNameFormat)

Set the archiveNameFormat property: Blob naming convention for archive, e.g.
Destination withBlobContainer(String blobContainer)

Set the blobContainer property: Blob container Name.
Destination withDataLakeAccountName(String dataLakeAccountName)

Set the dataLakeAccountName property: The Azure Data Lake Store name for the captured events.
Destination withDataLakeFolderPath(String dataLakeFolderPath)

Set the dataLakeFolderPath property: The destination folder path for the captured events.
Destination withDataLakeSubscriptionId(UUID dataLakeSubscriptionId)

Set the dataLakeSubscriptionId property: Subscription Id of Azure Data Lake Store.
Destination withIdentity(CaptureIdentity identity)

Set the identity property: A value that indicates whether capture description is enabled.
Destination withName(String name)

Set the name property: Name for capture destination.
Destination withStorageAccountResourceId(String storageAccountResourceId)

Set the storageAccountResourceId property: Resource id of the storage account to be used to create the blobs.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Destination

public Destination()

Creates an instance of Destination class.

Method Details

archiveNameFormat

public String archiveNameFormat()

Get the archiveNameFormat property: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order.

Returns:

the archiveNameFormat value.

blobContainer

public String blobContainer()

Get the blobContainer property: Blob container Name.

Returns:

the blobContainer value.

dataLakeAccountName

public String dataLakeAccountName()

Get the dataLakeAccountName property: The Azure Data Lake Store name for the captured events.

Returns:

the dataLakeAccountName value.

dataLakeFolderPath

public String dataLakeFolderPath()

Get the dataLakeFolderPath property: The destination folder path for the captured events.

Returns:

the dataLakeFolderPath value.

dataLakeSubscriptionId

public UUID dataLakeSubscriptionId()

Get the dataLakeSubscriptionId property: Subscription Id of Azure Data Lake Store.

Returns:

the dataLakeSubscriptionId value.

fromJson

public static Destination fromJson(JsonReader jsonReader)

Reads an instance of Destination from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

identity

public CaptureIdentity identity()

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

Returns:

the identity value.

name

public String name()

Get the name property: Name for capture destination.

Returns:

the name value.

storageAccountResourceId

public String storageAccountResourceId()

Get the storageAccountResourceId property: Resource id of the storage account to be used to create the blobs.

Returns:

the storageAccountResourceId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withArchiveNameFormat

public Destination withArchiveNameFormat(String archiveNameFormat)

Set the archiveNameFormat property: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order.

Parameters:

archiveNameFormat - the archiveNameFormat value to set.

Returns:

the Destination object itself.

withBlobContainer

public Destination withBlobContainer(String blobContainer)

Set the blobContainer property: Blob container Name.

Parameters:

blobContainer - the blobContainer value to set.

Returns:

the Destination object itself.

withDataLakeAccountName

public Destination withDataLakeAccountName(String dataLakeAccountName)

Set the dataLakeAccountName property: The Azure Data Lake Store name for the captured events.

Parameters:

dataLakeAccountName - the dataLakeAccountName value to set.

Returns:

the Destination object itself.

withDataLakeFolderPath

public Destination withDataLakeFolderPath(String dataLakeFolderPath)

Set the dataLakeFolderPath property: The destination folder path for the captured events.

Parameters:

dataLakeFolderPath - the dataLakeFolderPath value to set.

Returns:

the Destination object itself.

withDataLakeSubscriptionId

public Destination withDataLakeSubscriptionId(UUID dataLakeSubscriptionId)

Set the dataLakeSubscriptionId property: Subscription Id of Azure Data Lake Store.

Parameters:

dataLakeSubscriptionId - the dataLakeSubscriptionId value to set.

Returns:

the Destination object itself.

withIdentity

public Destination withIdentity(CaptureIdentity identity)

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

Parameters:

identity - the identity value to set.

Returns:

the Destination object itself.

withName

public Destination withName(String name)

Set the name property: Name for capture destination.

Parameters:

name - the name value to set.

Returns:

the Destination object itself.

withStorageAccountResourceId

public Destination withStorageAccountResourceId(String storageAccountResourceId)

Set the storageAccountResourceId property: Resource id of the storage account to be used to create the blobs.

Parameters:

storageAccountResourceId - the storageAccountResourceId value to set.

Returns:

the Destination object itself.

Applies to