Share via

EventHub Interface

  • Reference
Package:
com.azure.resourcemanager.eventhubs.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-eventhubs:2.44.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()
abstract String dataCaptureFileNameFormat()
abstract boolean dataCaptureSkipEmptyArchives()
abstract int dataCaptureWindowSizeInMB()
abstract int dataCaptureWindowSizeInSeconds()
abstract boolean isDataCaptureEnabled()
abstract PagedIterable<EventHubAuthorizationRule> listAuthorizationRules()
abstract PagedFlux<EventHubAuthorizationRule> listAuthorizationRulesAsync()
abstract PagedIterable<EventHubConsumerGroup> listConsumerGroups()
abstract PagedFlux<EventHubConsumerGroup> listConsumerGroupsAsync()
abstract int messageRetentionPeriodInDays()
abstract String namespaceName()
abstract String namespaceResourceGroupName()
abstract Set<String> partitionIds()

Method Details

captureDestination

public abstract Destination captureDestination()

Returns:

description of the destination where captured data will be stored

dataCaptureFileNameFormat

public abstract String dataCaptureFileNameFormat()

Returns:

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

dataCaptureSkipEmptyArchives

public abstract boolean dataCaptureSkipEmptyArchives()

Returns:

whether to skip empty archives when capturing is enabled

dataCaptureWindowSizeInMB

public abstract int dataCaptureWindowSizeInMB()

Returns:

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

dataCaptureWindowSizeInSeconds

public abstract int dataCaptureWindowSizeInSeconds()

Returns:

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

isDataCaptureEnabled

public abstract boolean isDataCaptureEnabled()

Returns:

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

listAuthorizationRules

public abstract PagedIterable listAuthorizationRules()

Returns:

authorization rules enabled for the event hub

listAuthorizationRulesAsync

public abstract PagedFlux listAuthorizationRulesAsync()

Returns:

authorization rules enabled for the event hub

listConsumerGroups

public abstract PagedIterable listConsumerGroups()

Returns:

consumer group in the event hub

listConsumerGroupsAsync

public abstract PagedFlux listConsumerGroupsAsync()

Returns:

consumer group in the event hub

messageRetentionPeriodInDays

public abstract int messageRetentionPeriodInDays()

Returns:

retention period of events in days

namespaceName

public abstract String namespaceName()

Returns:

name of the parent namespace

namespaceResourceGroupName

public abstract String namespaceResourceGroupName()

Returns:

the resource group of the parent namespace

partitionIds

public abstract Set partitionIds()

Returns:

the partition identifiers

Applies to