BatchServiceClient Interface

Package:

com.microsoft.azure.batch.protocol

public interface BatchServiceClient

The interface for BatchServiceClient class.

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() Gets The preferred language for the response..
Accounts	accounts() Gets the Accounts object to access its operations.
String	apiVersion() Gets Client API Version..
Applications	applications() Gets the Applications object to access its operations.
String	batchUrl() Gets The base URL for all Azure Batch service requests..
Certificates	certificates() Gets the Certificates object to access its operations.
ComputeNodes	computeNodes() Gets the ComputeNodes object to access its operations.
Files	files() Gets the Files object to access its operations.
boolean	generateClientRequestId() 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..
AzureClient	getAzureClient() Gets the AzureClient used for long running operations.
Jobs	jobs() Gets the Jobs object to access its operations.
JobSchedules	jobSchedules() Gets the JobSchedules object to access its operations.
int	longRunningOperationRetryTimeout() Gets The retry timeout in seconds for Long Running Operations. Default value is 30..
Pools	pools() Gets the Pools object to access its operations.
RestClient	restClient() Gets the REST client.
Tasks	tasks() Gets the Tasks object to access its operations.
String	userAgent() Gets the User-Agent header for the client.
BatchServiceClient	withAcceptLanguage(String acceptLanguage) Sets The preferred language for the response..
BatchServiceClient	withBatchUrl(String batchUrl) Sets The base URL for all Azure Batch service requests..
BatchServiceClient	withGenerateClientRequestId(boolean generateClientRequestId) 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..
BatchServiceClient	withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout) Sets The retry timeout in seconds for Long Running Operations. Default value is 30..

Method Details

acceptLanguage

public String acceptLanguage()

Gets The preferred language for the response..

Returns:

the acceptLanguage value.

accounts

public Accounts accounts()

Gets the Accounts object to access its operations.

Returns:

the Accounts object.

apiVersion

public String apiVersion()

Gets Client API Version..

Returns:

the apiVersion value.

applications

public Applications applications()

Gets the Applications object to access its operations.

Returns:

the Applications object.

batchUrl

public String batchUrl()

Gets The base URL for all Azure Batch service requests..

Returns:

the batchUrl value.

certificates

public Certificates certificates()

Gets the Certificates object to access its operations.

Returns:

the Certificates object.

computeNodes

public ComputeNodes computeNodes()

Gets the ComputeNodes object to access its operations.

Returns:

the ComputeNodes object.

files

public Files files()

Gets the Files object to access its operations.

Returns:

the Files object.

generateClientRequestId

public boolean generateClientRequestId()

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:

the generateClientRequestId value.

getAzureClient

public AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Returns:

the azure client;

jobs

public Jobs jobs()

Gets the Jobs object to access its operations.

Returns:

the Jobs object.

jobSchedules

public JobSchedules jobSchedules()

Gets the JobSchedules object to access its operations.

Returns:

the JobSchedules object.

longRunningOperationRetryTimeout

public int longRunningOperationRetryTimeout()

Gets The retry timeout in seconds for Long Running Operations. Default value is 30..

Returns:

the longRunningOperationRetryTimeout value.

pools

public Pools pools()

Gets the Pools object to access its operations.

Returns:

the Pools object.

restClient

public RestClient restClient()

Gets the REST client.

Returns:

the RestClient object.

tasks

public Tasks tasks()

Gets the Tasks object to access its operations.

Returns:

the Tasks object.

userAgent

public String userAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

withAcceptLanguage

public BatchServiceClient withAcceptLanguage(String acceptLanguage)

Sets The preferred language for the response..

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

withBatchUrl

public BatchServiceClient withBatchUrl(String batchUrl)

Sets The base URL for all Azure Batch service requests..

Parameters:

batchUrl - the batchUrl value.

Returns:

the service client itself

withGenerateClientRequestId

public BatchServiceClient withGenerateClientRequestId(boolean generateClientRequestId)

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..

Parameters:

generateClientRequestId - the generateClientRequestId value.

Returns:

the service client itself

withLongRunningOperationRetryTimeout

public BatchServiceClient withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

Sets The retry timeout in seconds for Long Running Operations. Default value is 30..

Parameters:

longRunningOperationRetryTimeout - the longRunningOperationRetryTimeout value.

Returns:

the service client itself