BatchServiceClient Interface

Package:

com.microsoft.azure.batch.protocol

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

public interface BatchServiceClient

The interface for BatchServiceClient class.

Method Summary

Modifier and Type	Method and Description
abstract String	acceptLanguage() Gets The preferred language for the response..
abstract Accounts	accounts() Gets the Accounts object to access its operations.
abstract String	apiVersion() Gets Client API Version..
abstract Applications	applications() Gets the Applications object to access its operations.
abstract String	batchUrl() Gets The base URL for all Azure Batch service requests..
abstract Certificates	certificates() Gets the Certificates object to access its operations.
abstract ComputeNodeExtensions	computeNodeExtensions() Gets the ComputeNodeExtensions object to access its operations.
abstract ComputeNodes	computeNodes() Gets the ComputeNodes object to access its operations.
abstract Files	files() Gets the Files object to access its operations.
abstract boolean	generateClientRequestId() Gets Whether a unique x-ms-client-request-id should be generated.
abstract com.microsoft.azure.AzureClient	getAzureClient() Gets the AzureClient used for long running operations.
abstract JobSchedules	jobSchedules() Gets the JobSchedules object to access its operations.
abstract Jobs	jobs() Gets the Jobs object to access its operations.
abstract int	longRunningOperationRetryTimeout() Gets The retry timeout in seconds for Long Running Operations.
abstract Pools	pools() Gets the Pools object to access its operations.
abstract com.microsoft.rest.RestClient	restClient() Gets the REST client.
abstract Tasks	tasks() Gets the Tasks object to access its operations.
abstract String	userAgent() Gets the User-Agent header for the client.
abstract BatchServiceClient	withAcceptLanguage(String acceptLanguage) Sets The preferred language for the response..
abstract BatchServiceClient	withBatchUrl(String batchUrl) Sets The base URL for all Azure Batch service requests..
abstract BatchServiceClient	withGenerateClientRequestId(boolean generateClientRequestId) Sets Whether a unique x-ms-client-request-id should be generated.
abstract BatchServiceClient	withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout) Sets The retry timeout in seconds for Long Running Operations.

Method Details

acceptLanguage

public abstract String acceptLanguage()

Gets The preferred language for the response..

Returns:

the acceptLanguage value.

accounts

public abstract Accounts accounts()

Gets the Accounts object to access its operations.

Returns:

the Accounts object.

apiVersion

public abstract String apiVersion()

Gets Client API Version..

Returns:

the apiVersion value.

applications

public abstract Applications applications()

Gets the Applications object to access its operations.

Returns:

the Applications object.

batchUrl

public abstract String batchUrl()

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

Returns:

the batchUrl value.

certificates

public abstract Certificates certificates()

Gets the Certificates object to access its operations.

Returns:

the Certificates object.

computeNodeExtensions

public abstract ComputeNodeExtensions computeNodeExtensions()

Gets the ComputeNodeExtensions object to access its operations.

Returns:

the ComputeNodeExtensions object.

computeNodes

public abstract ComputeNodes computeNodes()

Gets the ComputeNodes object to access its operations.

Returns:

the ComputeNodes object.

files

public abstract Files files()

Gets the Files object to access its operations.

Returns:

the Files object.

generateClientRequestId

public abstract 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 abstract AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Returns:

the azure client;

jobSchedules

public abstract JobSchedules jobSchedules()

Gets the JobSchedules object to access its operations.

Returns:

the JobSchedules object.

jobs

public abstract Jobs jobs()

Gets the Jobs object to access its operations.

Returns:

the Jobs object.

longRunningOperationRetryTimeout

public abstract int longRunningOperationRetryTimeout()

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

Returns:

the longRunningOperationRetryTimeout value.

pools

public abstract Pools pools()

Gets the Pools object to access its operations.

Returns:

the Pools object.

restClient

public abstract RestClient restClient()

Gets the REST client.

Returns:

the RestClient object.

tasks

public abstract Tasks tasks()

Gets the Tasks object to access its operations.

Returns:

the Tasks object.

userAgent

public abstract String userAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

withAcceptLanguage

public abstract BatchServiceClient withAcceptLanguage(String acceptLanguage)

Sets The preferred language for the response..

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

withBatchUrl

public abstract 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 abstract 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 abstract 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