BatchClient Class

Package:

com.microsoft.azure.batch

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

• java.lang.Object
• • com.microsoft.azure.batch.BatchClient

public class BatchClient

A client for an Azure Batch account, used to access the Batch service.

Method Summary

Modifier and Type	Method and Description
AccountOperations	accountOperations() Gets an AccountOperations object for performing account-related operations on the associated account.
ApplicationOperations	applicationOperations() Gets an ApplicationOperations object for performing application-related operations on the associated account.
CertificateOperations	certificateOperations() Gets a CertificateOperations object for performing certificate-related operations on the associated account.
ComputeNodeOperations	computeNodeOperations() Gets a ComputeNodeOperations object for performing compute node-related operations on the associated account.
Collection<BatchClientBehavior>	customBehaviors() Gets a collection of behaviors that modify or customize requests to the Batch service.
FileOperations	fileOperations() Gets a FileOperations object for performing file-related operations on the associated account.
JobOperations	jobOperations() Gets a JobOperations object for performing job-related operations on the associated account.
JobScheduleOperations	jobScheduleOperations() Gets a JobScheduleOperations object for performing job schedule-related operations on the associated account.
static BatchClient	open(BatchCredentials credentials) Creates an instance of BatchClient associated with the specified credentials.
static BatchClient	open(RestClient restClient, String baseUrl) Creates an instance of BatchClient associated with the specified restClient and baseurl.
PoolOperations	poolOperations() Gets a PoolOperations object for performing pool-related operations on the associated account.
BatchServiceClient	protocolLayer() Gets the protocol layer service client that issues requests to the Azure Batch service.
TaskOperations	taskOperations() Gets a TaskOperations object for performing task-related operations on the associated account.
BatchClient	withCustomBehaviors(Collection<BatchClientBehavior> customBehaviors) Sets a collection of behaviors that modify or customize requests to the Batch service.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

accountOperations

public AccountOperations accountOperations()

Gets an AccountOperations object for performing account-related operations on the associated account.

Returns:

An instance of the AccountOperations class.

applicationOperations

public ApplicationOperations applicationOperations()

Gets an ApplicationOperations object for performing application-related operations on the associated account.

Returns:

An instance of the ApplicationOperations class.

certificateOperations

@Deprecated
public CertificateOperations certificateOperations()

Gets a CertificateOperations object for performing certificate-related operations on the associated account. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Returns:

An instance of the CertificateOperations class.

computeNodeOperations

public ComputeNodeOperations computeNodeOperations()

Gets a ComputeNodeOperations object for performing compute node-related operations on the associated account.

Returns:

An instance of the ComputeNodeOperations class.

customBehaviors

public Collection customBehaviors()

Gets a collection of behaviors that modify or customize requests to the Batch service.

Returns:

The collection of BatchClientBehavior instances.

fileOperations

public FileOperations fileOperations()

Gets a FileOperations object for performing file-related operations on the associated account.

Returns:

An instance of the FileOperations class.

jobOperations

public JobOperations jobOperations()

Gets a JobOperations object for performing job-related operations on the associated account.

Returns:

An instance of the JobOperations class.

jobScheduleOperations

public JobScheduleOperations jobScheduleOperations()

Gets a JobScheduleOperations object for performing job schedule-related operations on the associated account.

Returns:

An instance of the JobScheduleOperations class.

open

public static BatchClient open(BatchCredentials credentials)

Creates an instance of BatchClient associated with the specified credentials.

Parameters:

credentials - A BatchCredentials object specifying the Batch account credentials.

Returns:

The new BatchClient instance.

open

public static BatchClient open(RestClient restClient, String baseUrl)

Creates an instance of BatchClient associated with the specified restClient and baseurl.

Parameters:

restClient - A RestClient object specifying the definition of rest client used to interact with batch endpoint.

baseUrl - A String object specifying the the batch end point.

Returns:

The new BatchClient instance.

poolOperations

public PoolOperations poolOperations()

Gets a PoolOperations object for performing pool-related operations on the associated account.

Returns:

An instance of the PoolOperations class.

protocolLayer

public BatchServiceClient protocolLayer()

Gets the protocol layer service client that issues requests to the Azure Batch service.

Returns:

The protocol layer client.

taskOperations

public TaskOperations taskOperations()

Gets a TaskOperations object for performing task-related operations on the associated account.

Returns:

An instance of the TaskOperations class.

withCustomBehaviors

public BatchClient withCustomBehaviors(Collection customBehaviors)

Sets a collection of behaviors that modify or customize requests to the Batch service.

Parameters:

customBehaviors - The collection of BatchClientBehavior instances.

Returns:

The current instance.