141 строка
10 KiB
YAML
141 строка
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials"
|
|
name: "BatchUserTokenCredentials"
|
|
nameWithType: "BatchUserTokenCredentials"
|
|
summary: "User token based credentials for use with a Batch Service Client."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.rest.credentials.TokenCredentials?alt=com.microsoft.rest.credentials.TokenCredentials&text=TokenCredentials\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials.applyCredentialsFilter(okhttp3.OkHttpClient.Builder)?alt=com.microsoft.rest.credentials.TokenCredentials.applyCredentialsFilter&text=applyCredentialsFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials.getScheme()?alt=com.microsoft.rest.credentials.TokenCredentials.getScheme&text=getScheme\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials.getToken(okhttp3.Request)?alt=com.microsoft.rest.credentials.TokenCredentials.getToken&text=getToken\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 **BatchUserTokenCredentials**</br> extends <xref href=\"com.microsoft.rest.credentials.TokenCredentials?alt=com.microsoft.rest.credentials.TokenCredentials&text=TokenCredentials\" data-throw-if-not-resolved=\"False\" /></br> implements <xref href=\"com.microsoft.azure.batch.auth.BatchCredentials?alt=com.microsoft.azure.batch.auth.BatchCredentials&text=BatchCredentials\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.BatchUserTokenCredentials(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.BatchUserTokenCredentials(String baseUrl, String clientId, String username, String password, String domain, String batchEndpoint, String authenticationEndpoint)"
|
|
name: "BatchUserTokenCredentials(String baseUrl, String clientId, String username, String password, String domain, String batchEndpoint, String authenticationEndpoint)"
|
|
nameWithType: "BatchUserTokenCredentials.BatchUserTokenCredentials(String baseUrl, String clientId, String username, String password, String domain, String batchEndpoint, String authenticationEndpoint)"
|
|
summary: "Initializes a new instance of the Batch<wbr>User<wbr>Token<wbr>Credentials."
|
|
parameters:
|
|
- description: "the Batch service endpoint."
|
|
name: "baseUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the Active Directory application client id."
|
|
name: "clientId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the user name for the Organization Id account."
|
|
name: "username"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the password for the Organization Id account."
|
|
name: "password"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the domain or tenant id containing this application."
|
|
name: "domain"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the Batch service endpoint to authenticate with."
|
|
name: "batchEndpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the Active Directory endpoint to authenticate with."
|
|
name: "authenticationEndpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public BatchUserTokenCredentials(String baseUrl, String clientId, String username, String password, String domain, String batchEndpoint, String authenticationEndpoint)"
|
|
desc: "Initializes a new instance of the BatchUserTokenCredentials."
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.authenticationEndpoint()"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.authenticationEndpoint()"
|
|
name: "authenticationEndpoint()"
|
|
nameWithType: "BatchUserTokenCredentials.authenticationEndpoint()"
|
|
summary: "Gets the Active Directory auth endpoint."
|
|
syntax: "public String authenticationEndpoint()"
|
|
desc: "Gets the Active Directory auth endpoint."
|
|
returns:
|
|
description: "the Active Directory auth endpoint."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.baseUrl()"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.baseUrl()"
|
|
name: "baseUrl()"
|
|
nameWithType: "BatchUserTokenCredentials.baseUrl()"
|
|
summary: "Gets the Batch service endpoint"
|
|
syntax: "public String baseUrl()"
|
|
desc: "Gets the Batch service endpoint"
|
|
returns:
|
|
description: "The Batch service endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.batchEndpoint()"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.batchEndpoint()"
|
|
name: "batchEndpoint()"
|
|
nameWithType: "BatchUserTokenCredentials.batchEndpoint()"
|
|
summary: "Gets the Batch service auth endpoint."
|
|
syntax: "public String batchEndpoint()"
|
|
desc: "Gets the Batch service auth endpoint."
|
|
returns:
|
|
description: "the Batch service auth endpoint."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.clientId()"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.clientId()"
|
|
name: "clientId()"
|
|
nameWithType: "BatchUserTokenCredentials.clientId()"
|
|
summary: "Gets the Active Directory application client id."
|
|
syntax: "public String clientId()"
|
|
desc: "Gets the Active Directory application client id."
|
|
returns:
|
|
description: "the active directory application client id."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.domain()"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.domain()"
|
|
name: "domain()"
|
|
nameWithType: "BatchUserTokenCredentials.domain()"
|
|
summary: "Gets the tenant or domain containing the application."
|
|
syntax: "public String domain()"
|
|
desc: "Gets the tenant or domain containing the application."
|
|
returns:
|
|
description: "the tenant or domain containing the application."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.getToken(okhttp3.Request)"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.getToken(Request request)"
|
|
name: "getToken(Request request)"
|
|
nameWithType: "BatchUserTokenCredentials.getToken(Request request)"
|
|
overridden: "com.microsoft.rest.credentials.TokenCredentials.getToken(okhttp3.Request)"
|
|
parameters:
|
|
- name: "request"
|
|
type: "<xref href=\"okhttp3.Request?alt=okhttp3.Request&text=Request\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public String getToken(Request request)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.username()"
|
|
fullName: "com.microsoft.azure.batch.auth.BatchUserTokenCredentials.username()"
|
|
name: "username()"
|
|
nameWithType: "BatchUserTokenCredentials.username()"
|
|
summary: "Gets the user name for the Organization Id account."
|
|
syntax: "public String username()"
|
|
desc: "Gets the user name for the Organization Id account."
|
|
returns:
|
|
description: "the user name."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "User token based credentials for use with a Batch Service Client."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.batch.auth.BatchCredentials?alt=com.microsoft.azure.batch.auth.BatchCredentials&text=BatchCredentials\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.auth"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|