azure-docs-sdk-java/docs-ref-autogen/com.azure.core.amqp.AmqpShu...

78 строки
5.4 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.core.amqp.AmqpShutdownSignal"
fullName: "com.azure.core.amqp.AmqpShutdownSignal"
name: "AmqpShutdownSignal"
nameWithType: "AmqpShutdownSignal"
summary: "Represents a signal that caused the AMQP connection to shutdown."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **AmqpShutdownSignal**"
constructors:
- uid: "com.azure.core.amqp.AmqpShutdownSignal.AmqpShutdownSignal(boolean,boolean,java.lang.String)"
fullName: "com.azure.core.amqp.AmqpShutdownSignal.AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message)"
name: "AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message)"
nameWithType: "AmqpShutdownSignal.AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message)"
summary: "Creates a new instance of the Amqp<wbr>Shutdown<wbr>Signal."
parameters:
- description: "Whether the shutdown signal can be retried or not."
name: "isTransient"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- description: "<code>true</code> if the shutdown was initiated by the client; <code>false</code> otherwise."
name: "isInitiatedByClient"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- description: "Message associated with the shutdown."
name: "message"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message)"
desc: "Creates a new instance of the AmqpShutdownSignal."
methods:
- uid: "com.azure.core.amqp.AmqpShutdownSignal.isInitiatedByClient()"
fullName: "com.azure.core.amqp.AmqpShutdownSignal.isInitiatedByClient()"
name: "isInitiatedByClient()"
nameWithType: "AmqpShutdownSignal.isInitiatedByClient()"
summary: "Gets whether or not this shutdown signal was initiated by the client."
syntax: "public boolean isInitiatedByClient()"
desc: "Gets whether or not this shutdown signal was initiated by the client."
returns:
description: "<code>true</code> if the shutdown signal was initiated by the client, <code>false</code> if the shutdown signal\n occurred in the underlying AMQP layer or from the AMQP message broker."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpShutdownSignal.isTransient()"
fullName: "com.azure.core.amqp.AmqpShutdownSignal.isTransient()"
name: "isTransient()"
nameWithType: "AmqpShutdownSignal.isTransient()"
summary: "Gets whether or not this shutdown signal is transient or if it can be restarted."
syntax: "public boolean isTransient()"
desc: "Gets whether or not this shutdown signal is transient or if it can be restarted."
returns:
description: "<code>true</code> if the shutdown signal is transient and the connection, session, or link can be recreated.\n <code>false</code> otherwise."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpShutdownSignal.toString()"
fullName: "com.azure.core.amqp.AmqpShutdownSignal.toString()"
name: "toString()"
nameWithType: "AmqpShutdownSignal.toString()"
summary: "Returns String representing the message of this `AmqpShutdownSignal` signal."
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Returns String representing the message of this `AmqpShutdownSignal` signal. **To write logs, please use <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.amqp.implementation.AmqpLoggingUtils#addShutdownSignal(LoggingEventBuilder, AmqpShutdownSignal)\"></xref>.**"
returns:
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Represents a signal that caused the AMQP connection to shutdown."
metadata: {}
package: "com.azure.core.amqp"
artifact: com.azure:azure-core-amqp:2.9.11