Clusters Interface

public interface Clusters

Resource collection API of Clusters.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Cluster resource.

abstract void delete(String resourceGroupName, String clusterName, Context context)

Deletes the specified cluster.

abstract void deleteById(String id)

Deletes the specified cluster.

abstract void deleteByIdWithResponse(String id, Context context)

Deletes the specified cluster.

abstract void deleteByResourceGroup(String resourceGroupName, String clusterName)

Deletes the specified cluster.

abstract Cluster getById(String id)

Gets information about the specified cluster.

abstract Response<Cluster> getByIdWithResponse(String id, Context context)

Gets information about the specified cluster.

abstract Cluster getByResourceGroup(String resourceGroupName, String clusterName)

Gets information about the specified cluster.

abstract Response<Cluster> getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Gets information about the specified cluster.

abstract PagedIterable<Cluster> list()

Lists all of the clusters in the given subscription.

abstract PagedIterable<Cluster> list(Context context)

Lists all of the clusters in the given subscription.

abstract PagedIterable<Cluster> listByResourceGroup(String resourceGroupName)

Lists all of the clusters in the given resource group.

abstract PagedIterable<Cluster> listByResourceGroup(String resourceGroupName, Context context)

Lists all of the clusters in the given resource group.

abstract PagedIterable<ClusterJob> listStreamingJobs(String resourceGroupName, String clusterName)

Lists all of the streaming jobs in the given cluster.

abstract PagedIterable<ClusterJob> listStreamingJobs(String resourceGroupName, String clusterName, Context context)

Lists all of the streaming jobs in the given cluster.

Method Details

define

public abstract Cluster.DefinitionStages.Blank define(String name)

Begins definition for a new Cluster resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Cluster definition.

delete

public abstract void delete(String resourceGroupName, String clusterName, Context context)

Deletes the specified cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes the specified cluster.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes the specified cluster.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String clusterName)

Deletes the specified cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

getById

public abstract Cluster getById(String id)

Gets information about the specified cluster.

Parameters:

id - the resource ID.

Returns:

information about the specified cluster along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets information about the specified cluster.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

information about the specified cluster along with Response<T>.

getByResourceGroup

public abstract Cluster getByResourceGroup(String resourceGroupName, String clusterName)

Gets information about the specified cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

information about the specified cluster.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String clusterName, Context context)

Gets information about the specified cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
context - The context to associate with this operation.

Returns:

information about the specified cluster along with Response<T>.

list

public abstract PagedIterable list()

Lists all of the clusters in the given subscription.

Returns:

a list of clusters populated by a 'list' operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(Context context)

Lists all of the clusters in the given subscription.

Parameters:

context - The context to associate with this operation.

Returns:

a list of clusters populated by a 'list' operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

Lists all of the clusters in the given resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

a list of clusters populated by a 'list' operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, Context context)

Lists all of the clusters in the given resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
context - The context to associate with this operation.

Returns:

a list of clusters populated by a 'list' operation as paginated response with PagedIterable<T>.

listStreamingJobs

public abstract PagedIterable listStreamingJobs(String resourceGroupName, String clusterName)

Lists all of the streaming jobs in the given cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.

Returns:

a list of streaming jobs as paginated response with PagedIterable<T>.

listStreamingJobs

public abstract PagedIterable listStreamingJobs(String resourceGroupName, String clusterName, Context context)

Lists all of the streaming jobs in the given cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
context - The context to associate with this operation.

Returns:

a list of streaming jobs as paginated response with PagedIterable<T>.

Applies to