azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.e...

270 строки
19 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.eventhubs.models.Destination"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination"
name: "Destination"
nameWithType: "Destination"
summary: "Capture storage details for capture description."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **Destination**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.Destination()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.Destination()"
name: "Destination()"
nameWithType: "Destination.Destination()"
summary: "Creates an instance of Destination class."
syntax: "public Destination()"
desc: "Creates an instance of Destination class."
methods:
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.archiveNameFormat()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.archiveNameFormat()"
name: "archiveNameFormat()"
nameWithType: "Destination.archiveNameFormat()"
summary: "Get the archive<wbr>Name<wbr>Format property: Blob naming convention for archive, e.<wbr>g."
syntax: "public String archiveNameFormat()"
desc: "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:
description: "the archiveNameFormat value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.blobContainer()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.blobContainer()"
name: "blobContainer()"
nameWithType: "Destination.blobContainer()"
summary: "Get the blob<wbr>Container property: Blob container Name."
syntax: "public String blobContainer()"
desc: "Get the blobContainer property: Blob container Name."
returns:
description: "the blobContainer value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.dataLakeAccountName()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.dataLakeAccountName()"
name: "dataLakeAccountName()"
nameWithType: "Destination.dataLakeAccountName()"
summary: "Get the data<wbr>Lake<wbr>Account<wbr>Name property: The Azure Data Lake Store name for the captured events."
syntax: "public String dataLakeAccountName()"
desc: "Get the dataLakeAccountName property: The Azure Data Lake Store name for the captured events."
returns:
description: "the dataLakeAccountName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.dataLakeFolderPath()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.dataLakeFolderPath()"
name: "dataLakeFolderPath()"
nameWithType: "Destination.dataLakeFolderPath()"
summary: "Get the data<wbr>Lake<wbr>Folder<wbr>Path property: The destination folder path for the captured events."
syntax: "public String dataLakeFolderPath()"
desc: "Get the dataLakeFolderPath property: The destination folder path for the captured events."
returns:
description: "the dataLakeFolderPath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.dataLakeSubscriptionId()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.dataLakeSubscriptionId()"
name: "dataLakeSubscriptionId()"
nameWithType: "Destination.dataLakeSubscriptionId()"
summary: "Get the data<wbr>Lake<wbr>Subscription<wbr>Id property: Subscription Id of Azure Data Lake Store."
syntax: "public UUID dataLakeSubscriptionId()"
desc: "Get the dataLakeSubscriptionId property: Subscription Id of Azure Data Lake Store."
returns:
description: "the dataLakeSubscriptionId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "Destination.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Destination from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static Destination fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the Destination."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of Destination from the JsonReader."
returns:
description: "An instance of Destination if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.identity()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.identity()"
name: "identity()"
nameWithType: "Destination.identity()"
summary: "Get the identity property: A value that indicates whether capture description is enabled."
syntax: "public CaptureIdentity identity()"
desc: "Get the identity property: A value that indicates whether capture description is enabled."
returns:
description: "the identity value."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.CaptureIdentity?alt=com.azure.resourcemanager.eventhubs.models.CaptureIdentity&text=CaptureIdentity\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.name()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.name()"
name: "name()"
nameWithType: "Destination.name()"
summary: "Get the name property: Name for capture destination."
syntax: "public String name()"
desc: "Get the name property: Name for capture destination."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.storageAccountResourceId()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.storageAccountResourceId()"
name: "storageAccountResourceId()"
nameWithType: "Destination.storageAccountResourceId()"
summary: "Get the storage<wbr>Account<wbr>Resource<wbr>Id property: Resource id of the storage account to be used to create the blobs."
syntax: "public String storageAccountResourceId()"
desc: "Get the storageAccountResourceId property: Resource id of the storage account to be used to create the blobs."
returns:
description: "the storageAccountResourceId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "Destination.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.validate()"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.validate()"
name: "validate()"
nameWithType: "Destination.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withArchiveNameFormat(java.lang.String)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withArchiveNameFormat(String archiveNameFormat)"
name: "withArchiveNameFormat(String archiveNameFormat)"
nameWithType: "Destination.withArchiveNameFormat(String archiveNameFormat)"
summary: "Set the archive<wbr>Name<wbr>Format property: Blob naming convention for archive, e.<wbr>g."
parameters:
- description: "the archiveNameFormat value to set."
name: "archiveNameFormat"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Destination withArchiveNameFormat(String archiveNameFormat)"
desc: "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."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withBlobContainer(java.lang.String)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withBlobContainer(String blobContainer)"
name: "withBlobContainer(String blobContainer)"
nameWithType: "Destination.withBlobContainer(String blobContainer)"
summary: "Set the blob<wbr>Container property: Blob container Name."
parameters:
- description: "the blobContainer value to set."
name: "blobContainer"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Destination withBlobContainer(String blobContainer)"
desc: "Set the blobContainer property: Blob container Name."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withDataLakeAccountName(java.lang.String)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withDataLakeAccountName(String dataLakeAccountName)"
name: "withDataLakeAccountName(String dataLakeAccountName)"
nameWithType: "Destination.withDataLakeAccountName(String dataLakeAccountName)"
summary: "Set the data<wbr>Lake<wbr>Account<wbr>Name property: The Azure Data Lake Store name for the captured events."
parameters:
- description: "the dataLakeAccountName value to set."
name: "dataLakeAccountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Destination withDataLakeAccountName(String dataLakeAccountName)"
desc: "Set the dataLakeAccountName property: The Azure Data Lake Store name for the captured events."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withDataLakeFolderPath(java.lang.String)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withDataLakeFolderPath(String dataLakeFolderPath)"
name: "withDataLakeFolderPath(String dataLakeFolderPath)"
nameWithType: "Destination.withDataLakeFolderPath(String dataLakeFolderPath)"
summary: "Set the data<wbr>Lake<wbr>Folder<wbr>Path property: The destination folder path for the captured events."
parameters:
- description: "the dataLakeFolderPath value to set."
name: "dataLakeFolderPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Destination withDataLakeFolderPath(String dataLakeFolderPath)"
desc: "Set the dataLakeFolderPath property: The destination folder path for the captured events."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withDataLakeSubscriptionId(java.util.UUID)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withDataLakeSubscriptionId(UUID dataLakeSubscriptionId)"
name: "withDataLakeSubscriptionId(UUID dataLakeSubscriptionId)"
nameWithType: "Destination.withDataLakeSubscriptionId(UUID dataLakeSubscriptionId)"
summary: "Set the data<wbr>Lake<wbr>Subscription<wbr>Id property: Subscription Id of Azure Data Lake Store."
parameters:
- description: "the dataLakeSubscriptionId value to set."
name: "dataLakeSubscriptionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
syntax: "public Destination withDataLakeSubscriptionId(UUID dataLakeSubscriptionId)"
desc: "Set the dataLakeSubscriptionId property: Subscription Id of Azure Data Lake Store."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withIdentity(com.azure.resourcemanager.eventhubs.models.CaptureIdentity)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withIdentity(CaptureIdentity identity)"
name: "withIdentity(CaptureIdentity identity)"
nameWithType: "Destination.withIdentity(CaptureIdentity identity)"
summary: "Set the identity property: A value that indicates whether capture description is enabled."
parameters:
- description: "the identity value to set."
name: "identity"
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.CaptureIdentity?alt=com.azure.resourcemanager.eventhubs.models.CaptureIdentity&text=CaptureIdentity\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Destination withIdentity(CaptureIdentity identity)"
desc: "Set the identity property: A value that indicates whether capture description is enabled."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withName(String name)"
name: "withName(String name)"
nameWithType: "Destination.withName(String name)"
summary: "Set the name property: Name for capture destination."
parameters:
- description: "the name value to set."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Destination withName(String name)"
desc: "Set the name property: Name for capture destination."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.eventhubs.models.Destination.withStorageAccountResourceId(java.lang.String)"
fullName: "com.azure.resourcemanager.eventhubs.models.Destination.withStorageAccountResourceId(String storageAccountResourceId)"
name: "withStorageAccountResourceId(String storageAccountResourceId)"
nameWithType: "Destination.withStorageAccountResourceId(String storageAccountResourceId)"
summary: "Set the storage<wbr>Account<wbr>Resource<wbr>Id property: Resource id of the storage account to be used to create the blobs."
parameters:
- description: "the storageAccountResourceId value to set."
name: "storageAccountResourceId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Destination withStorageAccountResourceId(String storageAccountResourceId)"
desc: "Set the storageAccountResourceId property: Resource id of the storage account to be used to create the blobs."
returns:
description: "the Destination object itself."
type: "<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Capture storage details for capture description."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.eventhubs.models.Destination?alt=com.azure.resourcemanager.eventhubs.models.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.eventhubs.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-eventhubs:2.42.0