294 строки
17 KiB
YAML
294 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.BatchServiceClient"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient"
|
|
name: "BatchServiceClient"
|
|
nameWithType: "BatchServiceClient"
|
|
summary: "The interface for Batch<wbr>Service<wbr>Client class."
|
|
syntax: "public interface **BatchServiceClient**"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.acceptLanguage()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.acceptLanguage()"
|
|
name: "acceptLanguage()"
|
|
nameWithType: "BatchServiceClient.acceptLanguage()"
|
|
summary: "Gets The preferred language for the response.."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String acceptLanguage()"
|
|
desc: "Gets The preferred language for the response.."
|
|
returns:
|
|
description: "the acceptLanguage value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.accounts()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.accounts()"
|
|
name: "accounts()"
|
|
nameWithType: "BatchServiceClient.accounts()"
|
|
summary: "Gets the Accounts object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Accounts accounts()"
|
|
desc: "Gets the Accounts object to access its operations."
|
|
returns:
|
|
description: "the Accounts object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Accounts?alt=com.microsoft.azure.batch.protocol.Accounts&text=Accounts\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.apiVersion()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.apiVersion()"
|
|
name: "apiVersion()"
|
|
nameWithType: "BatchServiceClient.apiVersion()"
|
|
summary: "Gets Client API Version.."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String apiVersion()"
|
|
desc: "Gets Client API Version.."
|
|
returns:
|
|
description: "the apiVersion value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.applications()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.applications()"
|
|
name: "applications()"
|
|
nameWithType: "BatchServiceClient.applications()"
|
|
summary: "Gets the Applications object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Applications applications()"
|
|
desc: "Gets the Applications object to access its operations."
|
|
returns:
|
|
description: "the Applications object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Applications?alt=com.microsoft.azure.batch.protocol.Applications&text=Applications\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.batchUrl()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.batchUrl()"
|
|
name: "batchUrl()"
|
|
nameWithType: "BatchServiceClient.batchUrl()"
|
|
summary: "Gets The base URL for all Azure Batch service requests.."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String batchUrl()"
|
|
desc: "Gets The base URL for all Azure Batch service requests.."
|
|
returns:
|
|
description: "the batchUrl value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.certificates()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.certificates()"
|
|
name: "certificates()"
|
|
nameWithType: "BatchServiceClient.certificates()"
|
|
summary: "Gets the Certificates object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Certificates certificates()"
|
|
desc: "Gets the Certificates object to access its operations."
|
|
returns:
|
|
description: "the Certificates object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Certificates?alt=com.microsoft.azure.batch.protocol.Certificates&text=Certificates\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.computeNodeExtensions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.computeNodeExtensions()"
|
|
name: "computeNodeExtensions()"
|
|
nameWithType: "BatchServiceClient.computeNodeExtensions()"
|
|
summary: "Gets the Compute<wbr>Node<wbr>Extensions object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract ComputeNodeExtensions computeNodeExtensions()"
|
|
desc: "Gets the ComputeNodeExtensions object to access its operations."
|
|
returns:
|
|
description: "the ComputeNodeExtensions object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.ComputeNodeExtensions?alt=com.microsoft.azure.batch.protocol.ComputeNodeExtensions&text=ComputeNodeExtensions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.computeNodes()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.computeNodes()"
|
|
name: "computeNodes()"
|
|
nameWithType: "BatchServiceClient.computeNodes()"
|
|
summary: "Gets the Compute<wbr>Nodes object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract ComputeNodes computeNodes()"
|
|
desc: "Gets the ComputeNodes object to access its operations."
|
|
returns:
|
|
description: "the ComputeNodes object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.ComputeNodes?alt=com.microsoft.azure.batch.protocol.ComputeNodes&text=ComputeNodes\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.files()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.files()"
|
|
name: "files()"
|
|
nameWithType: "BatchServiceClient.files()"
|
|
summary: "Gets the Files object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Files files()"
|
|
desc: "Gets the Files object to access its operations."
|
|
returns:
|
|
description: "the Files object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Files?alt=com.microsoft.azure.batch.protocol.Files&text=Files\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.generateClientRequestId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.generateClientRequestId()"
|
|
name: "generateClientRequestId()"
|
|
nameWithType: "BatchServiceClient.generateClientRequestId()"
|
|
summary: "Gets Whether a unique x-ms-client-request-id should be generated."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean generateClientRequestId()"
|
|
desc: "Gets Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.."
|
|
returns:
|
|
description: "the generateClientRequestId value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.getAzureClient()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.getAzureClient()"
|
|
name: "getAzureClient()"
|
|
nameWithType: "BatchServiceClient.getAzureClient()"
|
|
summary: "Gets the <xref uid=\"com.microsoft.azure.AzureClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureClient\"></xref> used for long running operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract AzureClient getAzureClient()"
|
|
desc: "Gets the <xref uid=\"com.microsoft.azure.AzureClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureClient\"></xref> used for long running operations."
|
|
returns:
|
|
description: "the azure client;"
|
|
type: "<xref href=\"com.microsoft.azure.AzureClient?alt=com.microsoft.azure.AzureClient&text=AzureClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.jobSchedules()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.jobSchedules()"
|
|
name: "jobSchedules()"
|
|
nameWithType: "BatchServiceClient.jobSchedules()"
|
|
summary: "Gets the Job<wbr>Schedules object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract JobSchedules jobSchedules()"
|
|
desc: "Gets the JobSchedules object to access its operations."
|
|
returns:
|
|
description: "the JobSchedules object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.JobSchedules?alt=com.microsoft.azure.batch.protocol.JobSchedules&text=JobSchedules\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.jobs()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.jobs()"
|
|
name: "jobs()"
|
|
nameWithType: "BatchServiceClient.jobs()"
|
|
summary: "Gets the Jobs object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Jobs jobs()"
|
|
desc: "Gets the Jobs object to access its operations."
|
|
returns:
|
|
description: "the Jobs object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Jobs?alt=com.microsoft.azure.batch.protocol.Jobs&text=Jobs\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.longRunningOperationRetryTimeout()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.longRunningOperationRetryTimeout()"
|
|
name: "longRunningOperationRetryTimeout()"
|
|
nameWithType: "BatchServiceClient.longRunningOperationRetryTimeout()"
|
|
summary: "Gets The retry timeout in seconds for Long Running Operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract int longRunningOperationRetryTimeout()"
|
|
desc: "Gets The retry timeout in seconds for Long Running Operations. Default value is 30.."
|
|
returns:
|
|
description: "the longRunningOperationRetryTimeout value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.pools()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.pools()"
|
|
name: "pools()"
|
|
nameWithType: "BatchServiceClient.pools()"
|
|
summary: "Gets the Pools object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Pools pools()"
|
|
desc: "Gets the Pools object to access its operations."
|
|
returns:
|
|
description: "the Pools object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Pools?alt=com.microsoft.azure.batch.protocol.Pools&text=Pools\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.restClient()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.restClient()"
|
|
name: "restClient()"
|
|
nameWithType: "BatchServiceClient.restClient()"
|
|
summary: "Gets the REST client."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract RestClient restClient()"
|
|
desc: "Gets the REST client."
|
|
returns:
|
|
description: "the <xref uid=\"com.microsoft.rest.RestClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RestClient\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.rest.RestClient?alt=com.microsoft.rest.RestClient&text=RestClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.tasks()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.tasks()"
|
|
name: "tasks()"
|
|
nameWithType: "BatchServiceClient.tasks()"
|
|
summary: "Gets the Tasks object to access its operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Tasks tasks()"
|
|
desc: "Gets the Tasks object to access its operations."
|
|
returns:
|
|
description: "the Tasks object."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.Tasks?alt=com.microsoft.azure.batch.protocol.Tasks&text=Tasks\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.userAgent()"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.userAgent()"
|
|
name: "userAgent()"
|
|
nameWithType: "BatchServiceClient.userAgent()"
|
|
summary: "Gets the User-Agent header for the client."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String userAgent()"
|
|
desc: "Gets the User-Agent header for the client."
|
|
returns:
|
|
description: "the user agent string."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.withAcceptLanguage(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.withAcceptLanguage(String acceptLanguage)"
|
|
name: "withAcceptLanguage(String acceptLanguage)"
|
|
nameWithType: "BatchServiceClient.withAcceptLanguage(String acceptLanguage)"
|
|
summary: "Sets The preferred language for the response.."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the acceptLanguage value."
|
|
name: "acceptLanguage"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract BatchServiceClient withAcceptLanguage(String acceptLanguage)"
|
|
desc: "Sets The preferred language for the response.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.BatchServiceClient?alt=com.microsoft.azure.batch.protocol.BatchServiceClient&text=BatchServiceClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.withBatchUrl(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.withBatchUrl(String batchUrl)"
|
|
name: "withBatchUrl(String batchUrl)"
|
|
nameWithType: "BatchServiceClient.withBatchUrl(String batchUrl)"
|
|
summary: "Sets The base URL for all Azure Batch service requests.."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the batchUrl value."
|
|
name: "batchUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract BatchServiceClient withBatchUrl(String batchUrl)"
|
|
desc: "Sets The base URL for all Azure Batch service requests.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.BatchServiceClient?alt=com.microsoft.azure.batch.protocol.BatchServiceClient&text=BatchServiceClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.withGenerateClientRequestId(boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
name: "withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
nameWithType: "BatchServiceClient.withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
summary: "Sets Whether a unique x-ms-client-request-id should be generated."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the generateClientRequestId value."
|
|
name: "generateClientRequestId"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract BatchServiceClient withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
desc: "Sets Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.BatchServiceClient?alt=com.microsoft.azure.batch.protocol.BatchServiceClient&text=BatchServiceClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.BatchServiceClient.withLongRunningOperationRetryTimeout(int)"
|
|
fullName: "com.microsoft.azure.batch.protocol.BatchServiceClient.withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
name: "withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
nameWithType: "BatchServiceClient.withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
summary: "Sets The retry timeout in seconds for Long Running Operations."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the longRunningOperationRetryTimeout value."
|
|
name: "longRunningOperationRetryTimeout"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract BatchServiceClient withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
desc: "Sets The retry timeout in seconds for Long Running Operations. Default value is 30.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.BatchServiceClient?alt=com.microsoft.azure.batch.protocol.BatchServiceClient&text=BatchServiceClient\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "interface"
|
|
desc: "The interface for BatchServiceClient class."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|