EventHubClientOptions Class

Package:

com.microsoft.azure.eventhubs

Maven Artifact:

com.microsoft.azure:azure-eventhubs:3.2.2

• java.lang.Object
• • com.microsoft.azure.eventhubs.EventHubClientOptions

public class EventHubClientOptions

Convenient container for options for creating an EventHubClient All options default to not specified (null)

Field Summary

Modifier and Type	Field and Description
static final Duration	SILENT_MINIMUM
static final Duration	SILENT_OFF

Constructor Summary

Constructor	Description
EventHubClientOptions()	Create with all defaults

Method Summary

Modifier and Type	Method and Description
Duration	getMaximumSilentTime() Gets the maximum silent time in seconds.
Duration	getOperationTimeout() Get the operation timeout.
ProxyConfiguration	getProxyConfiguration() Gets the proxy configuration for this set of options.
RetryPolicy	getRetryPolicy() Get the retry policy
TransportType	getTransportType() Get the transport type
EventHubClientOptions	setMaximumSilentTime(Duration maximumSilentTime) Sets the maximum silent time, in seconds.
EventHubClientOptions	setOperationTimeout(Duration operationTimeout) Set the operation timeout.
EventHubClientOptions	setProxyConfiguration(ProxyConfiguration proxyConfiguration) Sets the proxy configuration for the client options.
EventHubClientOptions	setRetryPolicy(RetryPolicy retryPolicy) Set the RetryPolicy for operations
EventHubClientOptions	setTransportType(TransportType transportType) Set the TransportType for the connection to the Event Hubs service

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Details

SILENT_MINIMUM

public static final Duration SILENT_MINIMUM

SILENT_OFF

public static final Duration SILENT_OFF

Constructor Details

EventHubClientOptions

public EventHubClientOptions()

Create with all defaults

Method Details

getMaximumSilentTime

public Duration getMaximumSilentTime()

Gets the maximum silent time in seconds.

Returns:

The maximum silent time, or SILENT_OFF.

getOperationTimeout

public Duration getOperationTimeout()

Get the operation timeout.

Returns:

operation timeout or null if not set

getProxyConfiguration

public ProxyConfiguration getProxyConfiguration()

Gets the proxy configuration for this set of options.

Returns:

Gets the proxy configuration.

getRetryPolicy

public RetryPolicy getRetryPolicy()

Get the retry policy

Returns:

RetryPolicy or null if not set

getTransportType

public TransportType getTransportType()

Get the transport type

Returns:

TransportType or null if not set

setMaximumSilentTime

public EventHubClientOptions setMaximumSilentTime(Duration maximumSilentTime)

Sets the maximum silent time, in seconds. Use only on recommendation from the product group.

Parameters:

maximumSilentTime - The time, or SILENT_OFF. Time must be at least SILENT_MINIMUM.

Returns:

The updated options object.

setOperationTimeout

public EventHubClientOptions setOperationTimeout(Duration operationTimeout)

Set the operation timeout.

Parameters:

operationTimeout - new operation timeout, null to unset any previous value

Returns:

this options object

setProxyConfiguration

public EventHubClientOptions setProxyConfiguration(ProxyConfiguration proxyConfiguration)

Sets the proxy configuration for the client options.

Parameters:

proxyConfiguration - The proxy configuration to set on the options.

Returns:

The updated options object.

setRetryPolicy

public EventHubClientOptions setRetryPolicy(RetryPolicy retryPolicy)

Set the RetryPolicy for operations

Parameters:

retryPolicy - new retry policy, null to unset any previous value

Returns:

this options object

setTransportType

public EventHubClientOptions setTransportType(TransportType transportType)

Set the TransportType for the connection to the Event Hubs service

Parameters:

transportType - new transport type, null to unset any previous value

Returns:

this options object