ClustersInner Class

Package:

com.microsoft.azure.management.batchai.implementation

• java.lang.Object
• • com.microsoft.azure.management.batchai.implementation.ClustersInner

public class ClustersInner

An instance of this class provides access to all the operations defined in Clusters.

Constructor Summary

Constructor	Description
ClustersInner(Retrofit retrofit, BatchAIManagementClientImpl client)	Initializes an instance of ClustersInner.

Method Summary

Modifier and Type	Method and Description
ClusterInner	beginCreate(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters) Creates a Cluster in the given Workspace.
Observable<ClusterInner>	beginCreateAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters) Creates a Cluster in the given Workspace.
ServiceFuture<ClusterInner>	beginCreateAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters, final ServiceCallback<ClusterInner> serviceCallback) Creates a Cluster in the given Workspace.
Observable<ServiceResponse<ClusterInner>>	beginCreateWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters) Creates a Cluster in the given Workspace.
void	beginDelete(String resourceGroupName, String workspaceName, String clusterName) Deletes a Cluster.
Observable<Void>	beginDeleteAsync(String resourceGroupName, String workspaceName, String clusterName) Deletes a Cluster.
ServiceFuture<Void>	beginDeleteAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback<Void> serviceCallback) Deletes a Cluster.
Observable<ServiceResponse<Void>>	beginDeleteWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName) Deletes a Cluster.
ClusterInner	create(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters) Creates a Cluster in the given Workspace.
Observable<ClusterInner>	createAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters) Creates a Cluster in the given Workspace.
ServiceFuture<ClusterInner>	createAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters, final ServiceCallback<ClusterInner> serviceCallback) Creates a Cluster in the given Workspace.
Observable<ServiceResponse<ClusterInner>>	createWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters) Creates a Cluster in the given Workspace.
void	delete(String resourceGroupName, String workspaceName, String clusterName) Deletes a Cluster.
Observable<Void>	deleteAsync(String resourceGroupName, String workspaceName, String clusterName) Deletes a Cluster.
ServiceFuture<Void>	deleteAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback<Void> serviceCallback) Deletes a Cluster.
Observable<ServiceResponse<Void>>	deleteWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName) Deletes a Cluster.
ClusterInner	get(String resourceGroupName, String workspaceName, String clusterName) Gets information about a Cluster.
Observable<ClusterInner>	getAsync(String resourceGroupName, String workspaceName, String clusterName) Gets information about a Cluster.
ServiceFuture<ClusterInner>	getAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback<ClusterInner> serviceCallback) Gets information about a Cluster.
Observable<ServiceResponse<ClusterInner>>	getWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName) Gets information about a Cluster.
PagedList<ClusterInner>	listByWorkspace(final String resourceGroupName, final String workspaceName) Gets information about Clusters associated with the given Workspace.
PagedList<ClusterInner>	listByWorkspace(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions) Gets information about Clusters associated with the given Workspace.
Observable<Page<ClusterInner>>	listByWorkspaceAsync(final String resourceGroupName, final String workspaceName) Gets information about Clusters associated with the given Workspace.
Observable<Page<ClusterInner>>	listByWorkspaceAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions) Gets information about Clusters associated with the given Workspace.
ServiceFuture<List<ClusterInner>>	listByWorkspaceAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions, final ListOperationCallback<ClusterInner> serviceCallback) Gets information about Clusters associated with the given Workspace.
ServiceFuture<List<ClusterInner>>	listByWorkspaceAsync(final String resourceGroupName, final String workspaceName, final ListOperationCallback<ClusterInner> serviceCallback) Gets information about Clusters associated with the given Workspace.
PagedList<ClusterInner>	listByWorkspaceNext(final String nextPageLink) Gets information about Clusters associated with the given Workspace.
Observable<Page<ClusterInner>>	listByWorkspaceNextAsync(final String nextPageLink) Gets information about Clusters associated with the given Workspace.
ServiceFuture<List<ClusterInner>>	listByWorkspaceNextAsync(final String nextPageLink, final ServiceFuture<List<ClusterInner>> serviceFuture, final ListOperationCallback<ClusterInner> serviceCallback) Gets information about Clusters associated with the given Workspace.
Observable<ServiceResponse<Page<ClusterInner>>>	listByWorkspaceNextSinglePageAsync(final String nextPageLink) Gets information about Clusters associated with the given Workspace. ServiceResponse<PageImpl<ClusterInner>> *
Observable<ServiceResponse<Page<ClusterInner>>>	listByWorkspaceNextWithServiceResponseAsync(final String nextPageLink) Gets information about Clusters associated with the given Workspace.
Observable<ServiceResponse<Page<ClusterInner>>>	listByWorkspaceSinglePageAsync(final String resourceGroupName, final String workspaceName) Gets information about Clusters associated with the given Workspace.
Observable<ServiceResponse<Page<ClusterInner>>>	listByWorkspaceSinglePageAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions) Gets information about Clusters associated with the given Workspace. ServiceResponse<PageImpl<ClusterInner>> *
Observable<ServiceResponse<Page<ClusterInner>>>	listByWorkspaceWithServiceResponseAsync(final String resourceGroupName, final String workspaceName) Gets information about Clusters associated with the given Workspace.
Observable<ServiceResponse<Page<ClusterInner>>>	listByWorkspaceWithServiceResponseAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions) Gets information about Clusters associated with the given Workspace.
PagedList<RemoteLoginInformationInner>	listRemoteLoginInformation(final String resourceGroupName, final String workspaceName, final String clusterName) Get the IP address, port of all the compute nodes in the Cluster.
Observable<Page<RemoteLoginInformationInner>>	listRemoteLoginInformationAsync(final String resourceGroupName, final String workspaceName, final String clusterName) Get the IP address, port of all the compute nodes in the Cluster.
ServiceFuture<List<RemoteLoginInformationInner>>	listRemoteLoginInformationAsync(final String resourceGroupName, final String workspaceName, final String clusterName, final ListOperationCallback<RemoteLoginInformationInner> serviceCallback) Get the IP address, port of all the compute nodes in the Cluster.
PagedList<RemoteLoginInformationInner>	listRemoteLoginInformationNext(final String nextPageLink) Get the IP address, port of all the compute nodes in the Cluster.
Observable<Page<RemoteLoginInformationInner>>	listRemoteLoginInformationNextAsync(final String nextPageLink) Get the IP address, port of all the compute nodes in the Cluster.
ServiceFuture<List<RemoteLoginInformationInner>>	listRemoteLoginInformationNextAsync(final String nextPageLink, final ServiceFuture<List<RemoteLoginInformationInner>> serviceFuture, final ListOperationCallback<RemoteLoginInformationInner> serviceCallback) Get the IP address, port of all the compute nodes in the Cluster.
Observable<ServiceResponse<Page<RemoteLoginInformationInner>>>	listRemoteLoginInformationNextSinglePageAsync(final String nextPageLink) Get the IP address, port of all the compute nodes in the Cluster. ServiceResponse<PageImpl<RemoteLoginInformationInner>> *
Observable<ServiceResponse<Page<RemoteLoginInformationInner>>>	listRemoteLoginInformationNextWithServiceResponseAsync(final String nextPageLink) Get the IP address, port of all the compute nodes in the Cluster.
Observable<ServiceResponse<Page<RemoteLoginInformationInner>>>	listRemoteLoginInformationSinglePageAsync(final String resourceGroupName, final String workspaceName, final String clusterName) Get the IP address, port of all the compute nodes in the Cluster. ServiceResponse<PageImpl<RemoteLoginInformationInner>> *
Observable<ServiceResponse<Page<RemoteLoginInformationInner>>>	listRemoteLoginInformationWithServiceResponseAsync(final String resourceGroupName, final String workspaceName, final String clusterName) Get the IP address, port of all the compute nodes in the Cluster.
ClusterInner	update(String resourceGroupName, String workspaceName, String clusterName) Updates properties of a Cluster.
ClusterInner	update(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings) Updates properties of a Cluster.
Observable<ClusterInner>	updateAsync(String resourceGroupName, String workspaceName, String clusterName) Updates properties of a Cluster.
ServiceFuture<ClusterInner>	updateAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback<ClusterInner> serviceCallback) Updates properties of a Cluster.
Observable<ClusterInner>	updateAsync(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings) Updates properties of a Cluster.
ServiceFuture<ClusterInner>	updateAsync(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings, final ServiceCallback<ClusterInner> serviceCallback) Updates properties of a Cluster.
Observable<ServiceResponse<ClusterInner>>	updateWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName) Updates properties of a Cluster.
Observable<ServiceResponse<ClusterInner>>	updateWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings) Updates properties of a Cluster.

Constructor Details

ClustersInner

public ClustersInner(Retrofit retrofit, BatchAIManagementClientImpl client)

Initializes an instance of ClustersInner.

Parameters:

retrofit - the Retrofit instance built from a Retrofit Builder.

client - the instance of the service client containing this operation class.

Method Details

beginCreate

public ClusterInner beginCreate(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

Returns:

the ClusterInner object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

beginCreateAsync

public Observable beginCreateAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

beginCreateAsync

public ServiceFuture beginCreateAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters, final ServiceCallback serviceCallback)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

beginCreateWithServiceResponseAsync

public Observable<>> beginCreateWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

beginDelete

public void beginDelete(String resourceGroupName, String workspaceName, String clusterName)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

beginDeleteAsync

public Observable beginDeleteAsync(String resourceGroupName, String workspaceName, String clusterName)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the ServiceResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

beginDeleteAsync

public ServiceFuture beginDeleteAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback serviceCallback)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

beginDeleteWithServiceResponseAsync

public Observable<>> beginDeleteWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the ServiceResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

create

public ClusterInner create(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

Returns:

the ClusterInner object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createAsync

public Observable createAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createAsync

public ServiceFuture createAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters, final ServiceCallback serviceCallback)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createWithServiceResponseAsync

public Observable<>> createWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName, ClusterCreateParameters parameters)

Creates a Cluster in the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

parameters - The parameters to provide for the Cluster creation.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public void delete(String resourceGroupName, String workspaceName, String clusterName)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(String resourceGroupName, String workspaceName, String clusterName)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback serviceCallback)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable<>> deleteWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName)

Deletes a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable for the request

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

public ClusterInner get(String resourceGroupName, String workspaceName, String clusterName)

Gets information about a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the ClusterInner object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

public Observable getAsync(String resourceGroupName, String workspaceName, String clusterName)

Gets information about a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback serviceCallback)

Gets information about a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable<>> getWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName)

Gets information about a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspace

public PagedList listByWorkspace(final String resourceGroupName, final String workspaceName)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the PagedList<ClusterInner> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listByWorkspace

public PagedList listByWorkspace(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clustersListByWorkspaceOptions - Additional parameters for the operation

Returns:

the PagedList<ClusterInner> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listByWorkspaceAsync

public Observable<>> listByWorkspaceAsync(final String resourceGroupName, final String workspaceName)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the PagedList<ClusterInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceAsync

public Observable<>> listByWorkspaceAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clustersListByWorkspaceOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ClusterInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceAsync

public ServiceFuture<>> listByWorkspaceAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions, final ListOperationCallback serviceCallback)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clustersListByWorkspaceOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceAsync

public ServiceFuture<>> listByWorkspaceAsync(final String resourceGroupName, final String workspaceName, final ListOperationCallback serviceCallback)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceNext

public PagedList listByWorkspaceNext(final String nextPageLink)

Gets information about Clusters associated with the given Workspace.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<ClusterInner> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listByWorkspaceNextAsync

public Observable<>> listByWorkspaceNextAsync(final String nextPageLink)

Gets information about Clusters associated with the given Workspace.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<ClusterInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceNextAsync

public ServiceFuture<>> listByWorkspaceNextAsync(final String nextPageLink, final ServiceFuture<>> serviceFuture, final ListOperationCallback serviceCallback)

Gets information about Clusters associated with the given Workspace.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceNextSinglePageAsync

public Observable<><>>> listByWorkspaceNextSinglePageAsync(final String nextPageLink)

Gets information about Clusters associated with the given Workspace.

ServiceResponse<PageImpl<ClusterInner>> *

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<ClusterInner> object wrapped in ServiceResponse if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceNextWithServiceResponseAsync

public Observable<><>>> listByWorkspaceNextWithServiceResponseAsync(final String nextPageLink)

Gets information about Clusters associated with the given Workspace.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<ClusterInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceSinglePageAsync

public Observable<><>>> listByWorkspaceSinglePageAsync(final String resourceGroupName, final String workspaceName)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the PagedList<ClusterInner> object wrapped in ServiceResponse if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceSinglePageAsync

public Observable<><>>> listByWorkspaceSinglePageAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions)

Gets information about Clusters associated with the given Workspace.

ServiceResponse<PageImpl<ClusterInner>> *

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs. ServiceResponse<PageImpl<ClusterInner>> *

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. ServiceResponse<PageImpl<ClusterInner>> *

clustersListByWorkspaceOptions - Additional parameters for the operation

Returns:

the PagedList<ClusterInner> object wrapped in ServiceResponse if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceWithServiceResponseAsync

public Observable<><>>> listByWorkspaceWithServiceResponseAsync(final String resourceGroupName, final String workspaceName)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the PagedList<ClusterInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listByWorkspaceWithServiceResponseAsync

public Observable<><>>> listByWorkspaceWithServiceResponseAsync(final String resourceGroupName, final String workspaceName, final ClustersListByWorkspaceOptions clustersListByWorkspaceOptions)

Gets information about Clusters associated with the given Workspace.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clustersListByWorkspaceOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ClusterInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformation

public PagedList listRemoteLoginInformation(final String resourceGroupName, final String workspaceName, final String clusterName)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the PagedList<RemoteLoginInformationInner> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listRemoteLoginInformationAsync

public Observable<>> listRemoteLoginInformationAsync(final String resourceGroupName, final String workspaceName, final String clusterName)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the PagedList<RemoteLoginInformationInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationAsync

public ServiceFuture<>> listRemoteLoginInformationAsync(final String resourceGroupName, final String workspaceName, final String clusterName, final ListOperationCallback serviceCallback)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationNext

public PagedList listRemoteLoginInformationNext(final String nextPageLink)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<RemoteLoginInformationInner> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listRemoteLoginInformationNextAsync

public Observable<>> listRemoteLoginInformationNextAsync(final String nextPageLink)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<RemoteLoginInformationInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationNextAsync

public ServiceFuture<>> listRemoteLoginInformationNextAsync(final String nextPageLink, final ServiceFuture<>> serviceFuture, final ListOperationCallback serviceCallback)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationNextSinglePageAsync

public Observable<><>>> listRemoteLoginInformationNextSinglePageAsync(final String nextPageLink)

Get the IP address, port of all the compute nodes in the Cluster.

ServiceResponse<PageImpl<RemoteLoginInformationInner>> *

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<RemoteLoginInformationInner> object wrapped in ServiceResponse if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationNextWithServiceResponseAsync

public Observable<><>>> listRemoteLoginInformationNextWithServiceResponseAsync(final String nextPageLink)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<RemoteLoginInformationInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationSinglePageAsync

public Observable<><>>> listRemoteLoginInformationSinglePageAsync(final String resourceGroupName, final String workspaceName, final String clusterName)

Get the IP address, port of all the compute nodes in the Cluster.

ServiceResponse<PageImpl<RemoteLoginInformationInner>> *

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs. ServiceResponse<PageImpl<RemoteLoginInformationInner>> *

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long. ServiceResponse<PageImpl<RemoteLoginInformationInner>> *

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the PagedList<RemoteLoginInformationInner> object wrapped in ServiceResponse if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listRemoteLoginInformationWithServiceResponseAsync

public Observable<><>>> listRemoteLoginInformationWithServiceResponseAsync(final String resourceGroupName, final String workspaceName, final String clusterName)

Get the IP address, port of all the compute nodes in the Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the PagedList<RemoteLoginInformationInner> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

public ClusterInner update(String resourceGroupName, String workspaceName, String clusterName)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the ClusterInner object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

update

public ClusterInner update(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

scaleSettings - Scale settings. Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters.

Returns:

the ClusterInner object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

CloudException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateAsync

public Observable updateAsync(String resourceGroupName, String workspaceName, String clusterName)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateAsync

public ServiceFuture updateAsync(String resourceGroupName, String workspaceName, String clusterName, final ServiceCallback serviceCallback)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateAsync

public Observable updateAsync(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

scaleSettings - Scale settings. Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateAsync

public ServiceFuture updateAsync(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings, final ServiceCallback serviceCallback)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

scaleSettings - Scale settings. Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateWithServiceResponseAsync

public Observable<>> updateWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateWithServiceResponseAsync

public Observable<>> updateWithServiceResponseAsync(String resourceGroupName, String workspaceName, String clusterName, ScaleSettings scaleSettings)

Updates properties of a Cluster.

Parameters:

resourceGroupName - Name of the resource group to which the resource belongs.

workspaceName - The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

clusterName - The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.

scaleSettings - Scale settings. Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters.

Returns:

the observable to the ClusterInner object

Throws:

IllegalArgumentException - thrown if parameters fail the validation