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

119 строки
9.1 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.eventhubs.ProxyConfiguration"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration"
name: "ProxyConfiguration"
nameWithType: "ProxyConfiguration"
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 **ProxyConfiguration**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html\">AutoCloseable</a>"
constructors:
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyConfiguration(com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyAuthenticationType,java.net.Proxy,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyConfiguration(ProxyConfiguration.ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
name: "ProxyConfiguration(ProxyConfiguration.ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
nameWithType: "ProxyConfiguration.ProxyConfiguration(ProxyConfiguration.ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
summary: "Creates a proxy configuration that uses the `proxyAddress` and authenticates with provided `username`, `password` and `authentication`."
parameters:
- description: "Authentication method to preemptively use with proxy."
name: "authentication"
type: "<xref href=\"com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyAuthenticationType?alt=com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyAuthenticationType&text=ProxyAuthenticationType\" data-throw-if-not-resolved=\"False\" />"
- description: "Proxy to use. If <code>null</code> is passed in, then the system configured <a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Proxy.html\">Proxy</a>\n is used."
name: "proxyAddress"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Proxy.html\">Proxy</a>"
- description: "Optional. Username used to authenticate with proxy. If not specified, the system-wide\n <a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Authenticator.html\">Authenticator</a> is used to fetch credentials."
name: "username"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Password used to authenticate with proxy."
name: "password"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ProxyConfiguration(ProxyConfiguration.ProxyAuthenticationType authentication, Proxy proxyAddress, String username, String password)"
desc: "Creates a proxy configuration that uses the `proxyAddress` and authenticates with provided `username`, `password` and `authentication`."
fields:
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.SYSTEM_DEFAULTS"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.SYSTEM_DEFAULTS"
name: "SYSTEM_DEFAULTS"
nameWithType: "ProxyConfiguration.SYSTEM_DEFAULTS"
summary: "Gets the system defaults for proxy configuration and authentication."
modifiers:
- "static"
- "final"
field:
type: "<xref href=\"com.microsoft.azure.eventhubs.ProxyConfiguration?alt=com.microsoft.azure.eventhubs.ProxyConfiguration&text=ProxyConfiguration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final ProxyConfiguration SYSTEM_DEFAULTS"
desc: "Gets the system defaults for proxy configuration and authentication."
methods:
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.authentication()"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.authentication()"
name: "authentication()"
nameWithType: "ProxyConfiguration.authentication()"
summary: "Gets the proxy authentication type to use."
syntax: "public ProxyConfiguration.ProxyAuthenticationType authentication()"
desc: "Gets the proxy authentication type to use."
returns:
description: "The proxy authentication type to use. returns <code>null</code> if no authentication type was set. This occurs\n when user uses <xref uid=\"com.microsoft.azure.eventhubs.ProxyConfiguration.SYSTEM_DEFAULTS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyConfiguration#SYSTEM_DEFAULTS\"></xref>."
type: "<xref href=\"com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyAuthenticationType?alt=com.microsoft.azure.eventhubs.ProxyConfiguration.ProxyAuthenticationType&text=ProxyAuthenticationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.close()"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.close()"
name: "close()"
nameWithType: "ProxyConfiguration.close()"
syntax: "public void close()"
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.credentials()"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.credentials()"
name: "credentials()"
nameWithType: "ProxyConfiguration.credentials()"
summary: "Gets credentials to authenticate against proxy with."
syntax: "public PasswordAuthentication credentials()"
desc: "Gets credentials to authenticate against proxy with."
returns:
description: "The credentials to authenticate against proxy with. Returns <code>null</code> if no credentials were set. This\n occurs when user uses <xref uid=\"com.microsoft.azure.eventhubs.ProxyConfiguration.SYSTEM_DEFAULTS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyConfiguration#SYSTEM_DEFAULTS\"></xref>."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/PasswordAuthentication.html\">PasswordAuthentication</a>"
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.hasUserDefinedCredentials()"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.hasUserDefinedCredentials()"
name: "hasUserDefinedCredentials()"
nameWithType: "ProxyConfiguration.hasUserDefinedCredentials()"
summary: "Gets whether the user has defined credentials."
syntax: "public boolean hasUserDefinedCredentials()"
desc: "Gets whether the user has defined credentials."
returns:
description: "true if the user has defined the credentials to use, false otherwise."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.isProxyAddressConfigured()"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.isProxyAddressConfigured()"
name: "isProxyAddressConfigured()"
nameWithType: "ProxyConfiguration.isProxyAddressConfigured()"
summary: "Gets whether the proxy address has been configured."
syntax: "public boolean isProxyAddressConfigured()"
desc: "Gets whether the proxy address has been configured. Used to determine whether to use system-defined or user-defined proxy."
returns:
description: "true if the proxy url has been set, and false otherwise."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventhubs.ProxyConfiguration.proxyAddress()"
fullName: "com.microsoft.azure.eventhubs.ProxyConfiguration.proxyAddress()"
name: "proxyAddress()"
nameWithType: "ProxyConfiguration.proxyAddress()"
summary: "Gets the proxy address."
syntax: "public Proxy proxyAddress()"
desc: "Gets the proxy address."
returns:
description: "The proxy address. Returns <code>null</code> if user creates proxy credentials with\n <xref uid=\"com.microsoft.azure.eventhubs.ProxyConfiguration.SYSTEM_DEFAULTS\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyConfiguration#SYSTEM_DEFAULTS\"></xref>."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/Proxy.html\">Proxy</a>"
type: "class"
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html\">AutoCloseable</a>"
metadata: {}
package: "com.microsoft.azure.eventhubs"
artifact: com.microsoft.azure:azure-eventhubs:3.2.2