198 строки
13 KiB
YAML
198 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.ConnectionError"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError"
|
|
name: "ConnectionError"
|
|
nameWithType: "ConnectionError"
|
|
summary: "The Connection<wbr>Error model."
|
|
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 final class **ConnectionError**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.ConnectionError()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.ConnectionError()"
|
|
name: "ConnectionError()"
|
|
nameWithType: "ConnectionError.ConnectionError()"
|
|
summary: "Creates an instance of Connection<wbr>Error class."
|
|
syntax: "public ConnectionError()"
|
|
desc: "Creates an instance of ConnectionError class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.connectionState()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.connectionState()"
|
|
name: "connectionState()"
|
|
nameWithType: "ConnectionError.connectionState()"
|
|
summary: "Get the connection<wbr>State property: The kind of connection error that occurred."
|
|
syntax: "public ConnectionState connectionState()"
|
|
desc: "Get the connectionState property: The kind of connection error that occurred."
|
|
returns:
|
|
description: "the connectionState value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionState?alt=com.azure.resourcemanager.cosmos.models.ConnectionState&text=ConnectionState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.exception()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.exception()"
|
|
name: "exception()"
|
|
nameWithType: "ConnectionError.exception()"
|
|
summary: "Get the exception property: Detailed error message about the failed connection."
|
|
syntax: "public String exception()"
|
|
desc: "Get the exception property: Detailed error message about the failed connection."
|
|
returns:
|
|
description: "the exception value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ConnectionError.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Connection<wbr>Error from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static ConnectionError fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the ConnectionError."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of ConnectionError from the JsonReader."
|
|
returns:
|
|
description: "An instance of ConnectionError if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.iPFrom()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.iPFrom()"
|
|
name: "iPFrom()"
|
|
nameWithType: "ConnectionError.iPFrom()"
|
|
summary: "Get the i<wbr>PFrom property: The IP of host that originated the failed connection."
|
|
syntax: "public String iPFrom()"
|
|
desc: "Get the iPFrom property: The IP of host that originated the failed connection."
|
|
returns:
|
|
description: "the iPFrom value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.iPTo()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.iPTo()"
|
|
name: "iPTo()"
|
|
nameWithType: "ConnectionError.iPTo()"
|
|
summary: "Get the i<wbr>PTo property: The IP that the connection attempted to reach."
|
|
syntax: "public String iPTo()"
|
|
desc: "Get the iPTo property: The IP that the connection attempted to reach."
|
|
returns:
|
|
description: "the iPTo value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.port()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.port()"
|
|
name: "port()"
|
|
nameWithType: "ConnectionError.port()"
|
|
summary: "Get the port property: The TCP port the connection was attempted on."
|
|
syntax: "public Integer port()"
|
|
desc: "Get the port property: The TCP port the connection was attempted on."
|
|
returns:
|
|
description: "the port value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ConnectionError.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ConnectionError.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.withConnectionState(com.azure.resourcemanager.cosmos.models.ConnectionState)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.withConnectionState(ConnectionState connectionState)"
|
|
name: "withConnectionState(ConnectionState connectionState)"
|
|
nameWithType: "ConnectionError.withConnectionState(ConnectionState connectionState)"
|
|
summary: "Set the connection<wbr>State property: The kind of connection error that occurred."
|
|
parameters:
|
|
- description: "the connectionState value to set."
|
|
name: "connectionState"
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionState?alt=com.azure.resourcemanager.cosmos.models.ConnectionState&text=ConnectionState\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ConnectionError withConnectionState(ConnectionState connectionState)"
|
|
desc: "Set the connectionState property: The kind of connection error that occurred."
|
|
returns:
|
|
description: "the ConnectionError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.withException(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.withException(String exception)"
|
|
name: "withException(String exception)"
|
|
nameWithType: "ConnectionError.withException(String exception)"
|
|
summary: "Set the exception property: Detailed error message about the failed connection."
|
|
parameters:
|
|
- description: "the exception value to set."
|
|
name: "exception"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionError withException(String exception)"
|
|
desc: "Set the exception property: Detailed error message about the failed connection."
|
|
returns:
|
|
description: "the ConnectionError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.withIPFrom(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.withIPFrom(String iPFrom)"
|
|
name: "withIPFrom(String iPFrom)"
|
|
nameWithType: "ConnectionError.withIPFrom(String iPFrom)"
|
|
summary: "Set the i<wbr>PFrom property: The IP of host that originated the failed connection."
|
|
parameters:
|
|
- description: "the iPFrom value to set."
|
|
name: "iPFrom"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionError withIPFrom(String iPFrom)"
|
|
desc: "Set the iPFrom property: The IP of host that originated the failed connection."
|
|
returns:
|
|
description: "the ConnectionError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.withIPTo(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.withIPTo(String iPTo)"
|
|
name: "withIPTo(String iPTo)"
|
|
nameWithType: "ConnectionError.withIPTo(String iPTo)"
|
|
summary: "Set the i<wbr>PTo property: The IP that the connection attempted to reach."
|
|
parameters:
|
|
- description: "the iPTo value to set."
|
|
name: "iPTo"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ConnectionError withIPTo(String iPTo)"
|
|
desc: "Set the iPTo property: The IP that the connection attempted to reach."
|
|
returns:
|
|
description: "the ConnectionError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ConnectionError.withPort(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ConnectionError.withPort(Integer port)"
|
|
name: "withPort(Integer port)"
|
|
nameWithType: "ConnectionError.withPort(Integer port)"
|
|
summary: "Set the port property: The TCP port the connection was attempted on."
|
|
parameters:
|
|
- description: "the port value to set."
|
|
name: "port"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ConnectionError withPort(Integer port)"
|
|
desc: "Set the port property: The TCP port the connection was attempted on."
|
|
returns:
|
|
description: "the ConnectionError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The ConnectionError model."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.ConnectionError?alt=com.azure.resourcemanager.cosmos.models.ConnectionError&text=ConnectionError\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.42.0
|