180 строки
14 KiB
YAML
180 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.eventhub.CaptureDescription"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription"
|
|
name: "CaptureDescription"
|
|
nameWithType: "CaptureDescription"
|
|
summary: "Properties to configure capture description for eventhub."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **CaptureDescription**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.CaptureDescription()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.CaptureDescription()"
|
|
name: "CaptureDescription()"
|
|
nameWithType: "CaptureDescription.CaptureDescription()"
|
|
syntax: "public CaptureDescription()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.destination()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.destination()"
|
|
name: "destination()"
|
|
nameWithType: "CaptureDescription.destination()"
|
|
summary: "Get properties of Destination where capture will be stored."
|
|
syntax: "public Destination destination()"
|
|
desc: "Get properties of Destination where capture will be stored. (Storage Account, Blob Names)."
|
|
returns:
|
|
description: "the destination value"
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.Destination?alt=com.microsoft.azure.management.eventhub.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.enabled()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.enabled()"
|
|
name: "enabled()"
|
|
nameWithType: "CaptureDescription.enabled()"
|
|
summary: "Get a value that indicates whether capture description is enabled."
|
|
syntax: "public Boolean enabled()"
|
|
desc: "Get a value that indicates whether capture description is enabled."
|
|
returns:
|
|
description: "the enabled value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.encoding()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.encoding()"
|
|
name: "encoding()"
|
|
nameWithType: "CaptureDescription.encoding()"
|
|
summary: "Get enumerates the possible values for the encoding format of capture description."
|
|
syntax: "public EncodingCaptureDescription encoding()"
|
|
desc: "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:
|
|
description: "the encoding value"
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.EncodingCaptureDescription?alt=com.microsoft.azure.management.eventhub.EncodingCaptureDescription&text=EncodingCaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.intervalInSeconds()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.intervalInSeconds()"
|
|
name: "intervalInSeconds()"
|
|
nameWithType: "CaptureDescription.intervalInSeconds()"
|
|
summary: "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."
|
|
syntax: "public Integer intervalInSeconds()"
|
|
desc: "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:
|
|
description: "the intervalInSeconds value"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.sizeLimitInBytes()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.sizeLimitInBytes()"
|
|
name: "sizeLimitInBytes()"
|
|
nameWithType: "CaptureDescription.sizeLimitInBytes()"
|
|
summary: "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."
|
|
syntax: "public Integer sizeLimitInBytes()"
|
|
desc: "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:
|
|
description: "the sizeLimitInBytes value"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.skipEmptyArchives()"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.skipEmptyArchives()"
|
|
name: "skipEmptyArchives()"
|
|
nameWithType: "CaptureDescription.skipEmptyArchives()"
|
|
summary: "Get a value that indicates whether to Skip Empty Archives."
|
|
syntax: "public Boolean skipEmptyArchives()"
|
|
desc: "Get a value that indicates whether to Skip Empty Archives."
|
|
returns:
|
|
description: "the skipEmptyArchives value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.withDestination(com.microsoft.azure.management.eventhub.Destination)"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.withDestination(Destination destination)"
|
|
name: "withDestination(Destination destination)"
|
|
nameWithType: "CaptureDescription.withDestination(Destination destination)"
|
|
summary: "Set properties of Destination where capture will be stored."
|
|
parameters:
|
|
- description: "the destination value to set"
|
|
name: "destination"
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.Destination?alt=com.microsoft.azure.management.eventhub.Destination&text=Destination\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CaptureDescription withDestination(Destination destination)"
|
|
desc: "Set properties of Destination where capture will be stored. (Storage Account, Blob Names)."
|
|
returns:
|
|
description: "the CaptureDescription object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.CaptureDescription?alt=com.microsoft.azure.management.eventhub.CaptureDescription&text=CaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.withEnabled(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.withEnabled(Boolean enabled)"
|
|
name: "withEnabled(Boolean enabled)"
|
|
nameWithType: "CaptureDescription.withEnabled(Boolean enabled)"
|
|
summary: "Set a value that indicates whether capture description is enabled."
|
|
parameters:
|
|
- description: "the enabled value to set"
|
|
name: "enabled"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CaptureDescription withEnabled(Boolean enabled)"
|
|
desc: "Set a value that indicates whether capture description is enabled."
|
|
returns:
|
|
description: "the CaptureDescription object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.CaptureDescription?alt=com.microsoft.azure.management.eventhub.CaptureDescription&text=CaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.withEncoding(com.microsoft.azure.management.eventhub.EncodingCaptureDescription)"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.withEncoding(EncodingCaptureDescription encoding)"
|
|
name: "withEncoding(EncodingCaptureDescription encoding)"
|
|
nameWithType: "CaptureDescription.withEncoding(EncodingCaptureDescription encoding)"
|
|
summary: "Set enumerates the possible values for the encoding format of capture description."
|
|
parameters:
|
|
- description: "the encoding value to set"
|
|
name: "encoding"
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.EncodingCaptureDescription?alt=com.microsoft.azure.management.eventhub.EncodingCaptureDescription&text=EncodingCaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CaptureDescription withEncoding(EncodingCaptureDescription encoding)"
|
|
desc: "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'."
|
|
returns:
|
|
description: "the CaptureDescription object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.CaptureDescription?alt=com.microsoft.azure.management.eventhub.CaptureDescription&text=CaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.withIntervalInSeconds(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.withIntervalInSeconds(Integer intervalInSeconds)"
|
|
name: "withIntervalInSeconds(Integer intervalInSeconds)"
|
|
nameWithType: "CaptureDescription.withIntervalInSeconds(Integer intervalInSeconds)"
|
|
summary: "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:
|
|
- description: "the intervalInSeconds value to set"
|
|
name: "intervalInSeconds"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CaptureDescription withIntervalInSeconds(Integer intervalInSeconds)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the CaptureDescription object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.CaptureDescription?alt=com.microsoft.azure.management.eventhub.CaptureDescription&text=CaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.withSizeLimitInBytes(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.withSizeLimitInBytes(Integer sizeLimitInBytes)"
|
|
name: "withSizeLimitInBytes(Integer sizeLimitInBytes)"
|
|
nameWithType: "CaptureDescription.withSizeLimitInBytes(Integer sizeLimitInBytes)"
|
|
summary: "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:
|
|
- description: "the sizeLimitInBytes value to set"
|
|
name: "sizeLimitInBytes"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CaptureDescription withSizeLimitInBytes(Integer sizeLimitInBytes)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the CaptureDescription object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.CaptureDescription?alt=com.microsoft.azure.management.eventhub.CaptureDescription&text=CaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.eventhub.CaptureDescription.withSkipEmptyArchives(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.eventhub.CaptureDescription.withSkipEmptyArchives(Boolean skipEmptyArchives)"
|
|
name: "withSkipEmptyArchives(Boolean skipEmptyArchives)"
|
|
nameWithType: "CaptureDescription.withSkipEmptyArchives(Boolean skipEmptyArchives)"
|
|
summary: "Set a value that indicates whether to Skip Empty Archives."
|
|
parameters:
|
|
- description: "the skipEmptyArchives value to set"
|
|
name: "skipEmptyArchives"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CaptureDescription withSkipEmptyArchives(Boolean skipEmptyArchives)"
|
|
desc: "Set a value that indicates whether to Skip Empty Archives."
|
|
returns:
|
|
description: "the CaptureDescription object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.eventhub.CaptureDescription?alt=com.microsoft.azure.management.eventhub.CaptureDescription&text=CaptureDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Properties to configure capture description for eventhub."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.eventhub"
|
|
artifact: com.microsoft.azure:azure-mgmt-eventhub:1.41.2
|