EventHub Interface

Package:

com.azure.resourcemanager.eventhubs.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventhubs:2.47.0

Implements

NestedResource HasManager<EventHubsManager> HasInnerModel<EventhubInner> Refreshable<EventHub> Updatable<Update>

public interface EventHub
extends NestedResource, HasManager<EventHubsManager>, Refreshable<EventHub>, Updatable<Update>, HasInnerModel<EventhubInner>

Type representing an Azure EventHub.

Method Summary

Modifier and Type	Method and Description
abstract Destination	captureDestination() Gets description of the destination where captured data will be stored.
abstract String	dataCaptureFileNameFormat() Gets the format file name that stores captured data when capturing is enabled.
abstract boolean	dataCaptureSkipEmptyArchives() Checks whether to skip empty archives when capturing is enabled.
abstract int	dataCaptureWindowSizeInMB() Gets configured window in MB to be used for event capturing when capturing is enabled.
abstract int	dataCaptureWindowSizeInSeconds() Gets configured window in seconds to be used for event capturing when capturing is enabled.
abstract boolean	isDataCaptureEnabled() Checks whether the data capture enabled for the event hub events.
abstract PagedIterable<EventHubAuthorizationRule>	listAuthorizationRules() Gets authorization rules enabled for the event hub.
abstract PagedFlux<EventHubAuthorizationRule>	listAuthorizationRulesAsync() Gets authorization rules enabled for the event hub.
abstract PagedIterable<EventHubConsumerGroup>	listConsumerGroups() Gets consumer group in the event hub.
abstract PagedFlux<EventHubConsumerGroup>	listConsumerGroupsAsync() Gets consumer group in the event hub.
abstract int	messageRetentionPeriodInDays() Gets retention period of events in days.
abstract String	namespaceName() Gets name of the parent namespace.
abstract String	namespaceResourceGroupName() Gets the resource group of the parent namespace.
abstract Set<String>	partitionIds() Gets the partition identifiers.

Method Details

captureDestination

public abstract Destination captureDestination()

Gets description of the destination where captured data will be stored.

Returns:

description of the destination where captured data will be stored

dataCaptureFileNameFormat

public abstract String dataCaptureFileNameFormat()

Gets the format file name that stores captured data when capturing is enabled.

Returns:

the format file name that stores captured data when capturing is enabled

dataCaptureSkipEmptyArchives

public abstract boolean dataCaptureSkipEmptyArchives()

Checks whether to skip empty archives when capturing is enabled.

Returns:

whether to skip empty archives when capturing is enabled

dataCaptureWindowSizeInMB

public abstract int dataCaptureWindowSizeInMB()

Gets configured window in MB to be used for event capturing when capturing is enabled.

Returns:

configured window in MB to be used for event capturing when capturing is enabled

dataCaptureWindowSizeInSeconds

public abstract int dataCaptureWindowSizeInSeconds()

Gets configured window in seconds to be used for event capturing when capturing is enabled.

Returns:

configured window in seconds to be used for event capturing when capturing is enabled

isDataCaptureEnabled

public abstract boolean isDataCaptureEnabled()

Checks whether the data capture enabled for the event hub events.

Returns:

true if the data capture enabled for the event hub events, false otherwise

listAuthorizationRules

public abstract PagedIterable listAuthorizationRules()

Gets authorization rules enabled for the event hub.

Returns:

authorization rules enabled for the event hub

listAuthorizationRulesAsync

public abstract PagedFlux listAuthorizationRulesAsync()

Gets authorization rules enabled for the event hub.

Returns:

authorization rules enabled for the event hub

listConsumerGroups

public abstract PagedIterable listConsumerGroups()

Gets consumer group in the event hub.

Returns:

consumer group in the event hub

listConsumerGroupsAsync

public abstract PagedFlux listConsumerGroupsAsync()

Gets consumer group in the event hub.

Returns:

consumer group in the event hub

messageRetentionPeriodInDays

public abstract int messageRetentionPeriodInDays()

Gets retention period of events in days.

Returns:

retention period of events in days

namespaceName

public abstract String namespaceName()

Gets name of the parent namespace.

Returns:

name of the parent namespace

namespaceResourceGroupName

public abstract String namespaceResourceGroupName()

Gets the resource group of the parent namespace.

Returns:

the resource group of the parent namespace

partitionIds

public abstract Set partitionIds()

Gets the partition identifiers.

Returns:

the partition identifiers