azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.eventhu...

359 строки
16 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.eventhubs._event_hub_exception
id: _event_hub_exception
parent: com.microsoft.azure.eventhubs
children:
- com.microsoft.azure.eventhubs._event_hub_exception.EventHubException(final boolean,final String)
- com.microsoft.azure.eventhubs._event_hub_exception.EventHubException(final boolean,final String,final Throwable)
- com.microsoft.azure.eventhubs._event_hub_exception.EventHubException(final boolean,final Throwable)
- com.microsoft.azure.eventhubs._event_hub_exception.getContext()
- com.microsoft.azure.eventhubs._event_hub_exception.getIsTransient()
- com.microsoft.azure.eventhubs._event_hub_exception.getMessage()
- com.microsoft.azure.eventhubs._event_hub_exception.setContext(ErrorContext)
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: EventHubException
nameWithType: EventHubException
fullName: com.microsoft.azure.eventhubs.EventHubException
type: Class
source:
remote: &o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
branch: master
repo: https://github.com/Azure/azure-event-hubs-java
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 13
package: com.microsoft.azure.eventhubs
summary: <p>This is the base exception that service bus will produce for all error cases. </p>
syntax:
content: public class EventHubException
inheritance:
- java.lang.Object
- Exception
- uid: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException(final boolean,final String)
id: EventHubException(final boolean,final String)
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: EventHubException(final boolean isTransient, final String message)
nameWithType: EventHubException.EventHubException(final boolean isTransient, final String message)
fullName: com.microsoft.azure.eventhubs.EventHubException.EventHubException(final boolean isTransient, final String message)
overload: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException*
type: Constructor
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 24
package: com.microsoft.azure.eventhubs
syntax:
content: public EventHubException(final boolean isTransient, final String message)
parameters:
- id: isTransient
type: 4dda0764
- id: message
type: 3d93591e
- uid: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException(final boolean,final String,final Throwable)
id: EventHubException(final boolean,final String,final Throwable)
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: EventHubException(final boolean isTransient, final String message, final Throwable cause)
nameWithType: EventHubException.EventHubException(final boolean isTransient, final String message, final Throwable cause)
fullName: com.microsoft.azure.eventhubs.EventHubException.EventHubException(final boolean isTransient, final String message, final Throwable cause)
overload: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException*
type: Constructor
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 34
package: com.microsoft.azure.eventhubs
syntax:
content: public EventHubException(final boolean isTransient, final String message, final Throwable cause)
parameters:
- id: isTransient
type: 4dda0764
- id: message
type: 3d93591e
- id: cause
type: fa00b19f
- uid: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException(final boolean,final Throwable)
id: EventHubException(final boolean,final Throwable)
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: EventHubException(final boolean isTransient, final Throwable cause)
nameWithType: EventHubException.EventHubException(final boolean isTransient, final Throwable cause)
fullName: com.microsoft.azure.eventhubs.EventHubException.EventHubException(final boolean isTransient, final Throwable cause)
overload: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException*
type: Constructor
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 29
package: com.microsoft.azure.eventhubs
syntax:
content: public EventHubException(final boolean isTransient, final Throwable cause)
parameters:
- id: isTransient
type: 4dda0764
- id: cause
type: fa00b19f
- uid: com.microsoft.azure.eventhubs._event_hub_exception.getContext()
id: getContext()
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: getContext()
nameWithType: EventHubException.getContext()
fullName: com.microsoft.azure.eventhubs.EventHubException.getContext()
overload: com.microsoft.azure.eventhubs._event_hub_exception.getContext*
type: Method
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 58
package: com.microsoft.azure.eventhubs
syntax:
content: public ErrorContext getContext()
return:
type: com.microsoft.azure.eventhubs._error_context
- uid: com.microsoft.azure.eventhubs._event_hub_exception.getIsTransient()
id: getIsTransient()
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: getIsTransient()
nameWithType: EventHubException.getIsTransient()
fullName: com.microsoft.azure.eventhubs.EventHubException.getIsTransient()
overload: com.microsoft.azure.eventhubs._event_hub_exception.getIsTransient*
type: Method
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 54
package: com.microsoft.azure.eventhubs
summary: >-
<p>A boolean indicating if the exception is a transient error or not.</p>
<p></p>
syntax:
content: public boolean getIsTransient()
return:
type: 4fc6e284
description: <p>returns true when user can retry the operation that generated the exception without additional intervention. </p>
- uid: com.microsoft.azure.eventhubs._event_hub_exception.getMessage()
id: getMessage()
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: getMessage()
nameWithType: EventHubException.getMessage()
fullName: com.microsoft.azure.eventhubs.EventHubException.getMessage()
overload: com.microsoft.azure.eventhubs._event_hub_exception.getMessage*
type: Method
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 40
package: com.microsoft.azure.eventhubs
syntax:
content: public String getMessage()
return:
type: "26831127"
- uid: com.microsoft.azure.eventhubs._event_hub_exception.setContext(ErrorContext)
id: setContext(ErrorContext)
parent: com.microsoft.azure.eventhubs._event_hub_exception
href: com.microsoft.azure.eventhubs._event_hub_exception.yml
langs:
- java
name: setContext(ErrorContext errorContext)
nameWithType: EventHubException.setContext(ErrorContext errorContext)
fullName: com.microsoft.azure.eventhubs.EventHubException.setContext(ErrorContext errorContext)
overload: com.microsoft.azure.eventhubs._event_hub_exception.setContext*
type: Method
source:
remote: *o0
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubException.java
startLine: 62
package: com.microsoft.azure.eventhubs
syntax:
content: public void setContext(ErrorContext errorContext)
parameters:
- id: errorContext
type: com.microsoft.azure.eventhubs._error_context
references:
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: 3d93591e
spec.java:
- name: final String
fullName: final String
- uid: com.microsoft.azure.eventhubs._event_hub_exception.EventHubException*
name: EventHubException
nameWithType: EventHubException.EventHubException
fullName: com.microsoft.azure.eventhubs.EventHubException.EventHubException
package: com.microsoft.azure.eventhubs
- uid: fa00b19f
spec.java:
- name: final Throwable
fullName: final Throwable
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.eventhubs._event_hub_exception.getMessage*
name: getMessage
nameWithType: EventHubException.getMessage
fullName: com.microsoft.azure.eventhubs.EventHubException.getMessage
package: com.microsoft.azure.eventhubs
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.eventhubs._event_hub_exception.getIsTransient*
name: getIsTransient
nameWithType: EventHubException.getIsTransient
fullName: com.microsoft.azure.eventhubs.EventHubException.getIsTransient
package: com.microsoft.azure.eventhubs
- uid: com.microsoft.azure.eventhubs._event_hub_exception.getContext*
name: getContext
nameWithType: EventHubException.getContext
fullName: com.microsoft.azure.eventhubs.EventHubException.getContext
package: com.microsoft.azure.eventhubs
- uid: com.microsoft.azure.eventhubs._event_hub_exception.setContext*
name: setContext
nameWithType: EventHubException.setContext
fullName: com.microsoft.azure.eventhubs.EventHubException.setContext
package: com.microsoft.azure.eventhubs
- uid: com.microsoft.azure.eventhubs._authorization_failed_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._authorization_failed_exception.yml
name: AuthorizationFailedException
nameWithType: AuthorizationFailedException
fullName: com.microsoft.azure.eventhubs.AuthorizationFailedException
type: Class
summary: >-
<p>Authorization failed exception is thrown when error is encountered during authorizing user's permission to run the intended operations. When encountered this exception user should check whether the token/key provided in the connection string (e.g. one passed to <xref uid="com.microsoft.azure.eventhubs._event_hub_client.create(final String,final Executor)" data-throw-if-not-resolved="false">EventHubClient#create(String, Executor)</xref>) is valid, and has correct execution right for the intended operations (e.g. Receive call will need Listen claim associated with the key/token).</p>
<p></p>
syntax:
content: public class AuthorizationFailedException extends EventHubException
- uid: com.microsoft.azure.eventhubs._communication_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._communication_exception.yml
name: CommunicationException
nameWithType: CommunicationException
fullName: com.microsoft.azure.eventhubs.CommunicationException
type: Class
summary: >-
<p>This exception is thrown when there is a client side connectivity issue. When receiving this exception user should check client connectivity settings to the service: <ul><li><p>Check for correct hostname and port number used in endpoint. </p></li><li><p>Check for any possible proxy settings that can block amqp ports </p></li><li><p>Check for any firewall settings that can block amqp ports </p></li><li><p>Check for any general network connectivity issues, as well as network latency. </p></li></ul></p>
<p></p>
syntax:
content: public class CommunicationException extends EventHubException
- uid: com.microsoft.azure.eventhubs._illegal_entity_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._illegal_entity_exception.yml
name: IllegalEntityException
nameWithType: IllegalEntityException
fullName: com.microsoft.azure.eventhubs.IllegalEntityException
type: Class
summary: >-
<p>This exception is thrown for the following reasons: <ul><li><p>When the entity user attempted to connect does not exist </p></li><li><p>The entity user wants to connect is disabled </p></li></ul></p>
<p></p>
syntax:
content: public class IllegalEntityException
- uid: com.microsoft.azure.eventhubs._operation_cancelled_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._operation_cancelled_exception.yml
name: OperationCancelledException
nameWithType: OperationCancelledException
fullName: com.microsoft.azure.eventhubs.OperationCancelledException
type: Class
summary: <p>This exception is thrown when the underlying Amqp layer encounter an abnormal link abort or disconnect of connection in an unexpected fashion. </p>
syntax:
content: public class OperationCancelledException
- uid: com.microsoft.azure.eventhubs._payload_size_exceeded_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._payload_size_exceeded_exception.yml
name: PayloadSizeExceededException
nameWithType: PayloadSizeExceededException
fullName: com.microsoft.azure.eventhubs.PayloadSizeExceededException
type: Class
summary: >-
<p>this exception is thrown when user attempts to send a event data or brokered message that has exceeded the allowed payload size as defined by the service. Note that in a batch send scenario the limit can include possible batch overhead.</p>
<p></p>
syntax:
content: public class PayloadSizeExceededException
- uid: com.microsoft.azure.eventhubs._quota_exceeded_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._quota_exceeded_exception.yml
name: QuotaExceededException
nameWithType: QuotaExceededException
fullName: com.microsoft.azure.eventhubs.QuotaExceededException
type: Class
syntax:
content: public class QuotaExceededException
- uid: com.microsoft.azure.eventhubs._receiver_disconnected_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._receiver_disconnected_exception.yml
name: ReceiverDisconnectedException
nameWithType: ReceiverDisconnectedException
fullName: com.microsoft.azure.eventhubs.ReceiverDisconnectedException
type: Class
summary: >-
<p>This exception is thrown when a EventHubReceiver is being disconnected because of one of the following reason: <ul><li><p>user attempts to connect a non-epoch receiver to a event hub partition, when there is an epoch receiver connected to the partition. </p></li><li><p>you are using an epoch receiver for a given partition but another epoch receiver with a higher epoch value connects to the same partition. </p></li></ul>
User should make sure either all code are using non-epoch receivers, or ensure that there is only one epoch receiver processing a given partition at any given point in time.</p>
<p></p>
syntax:
content: public class ReceiverDisconnectedException
- uid: com.microsoft.azure.eventhubs._server_busy_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._server_busy_exception.yml
name: ServerBusyException
nameWithType: ServerBusyException
fullName: com.microsoft.azure.eventhubs.ServerBusyException
type: Class
summary: >-
<p>Server busy exception is thrown when the current entity's activity has put excessive load onto the service. When encountered this exception user should wait at least 4 seconds before any retry/runtime operations for the said entity again.</p>
<p></p>
syntax:
content: public class ServerBusyException
- uid: com.microsoft.azure.eventhubs._timeout_exception
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._timeout_exception.yml
name: TimeoutException
nameWithType: TimeoutException
fullName: com.microsoft.azure.eventhubs.TimeoutException
type: Class
summary: >-
<p>This exception is thrown when the operation has exceeded the predetermined time limit. User should check connectivity is healthy between client process and service.</p>
<p></p>
syntax:
content: public class TimeoutException
- uid: com.microsoft.azure.eventhubs._error_context
parent: com.microsoft.azure.eventhubs
href: com.microsoft.azure.eventhubs._error_context.yml
name: ErrorContext
nameWithType: ErrorContext
fullName: com.microsoft.azure.eventhubs.ErrorContext
type: Class
syntax:
content: public class ErrorContext