ClustersClient Interface

public interface ClustersClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, String ifNoneMatch, Context context)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName)

Deletes the specified cluster.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String clusterName, Context context)

Deletes the specified cluster.

abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, ClusterInner cluster)

Updates an existing cluster.

abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, Context context)

Updates an existing cluster.

abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, String ifNoneMatch, Context context)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

abstract void delete(String resourceGroupName, String clusterName)

Deletes the specified cluster.

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

Deletes the specified cluster.

abstract ClusterInner getByResourceGroup(String resourceGroupName, String clusterName)

Gets information about the specified cluster.

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

Gets information about the specified cluster.

abstract PagedIterable<ClusterInner> list()

Lists all of the clusters in the given subscription.

abstract PagedIterable<ClusterInner> list(Context context)

Lists all of the clusters in the given subscription.

abstract PagedIterable<ClusterInner> listByResourceGroup(String resourceGroupName)

Lists all of the clusters in the given resource group.

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

Lists all of the clusters in the given resource group.

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

Lists all of the streaming jobs in the given cluster.

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

Lists all of the streaming jobs in the given cluster.

abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterInner cluster)

Updates an existing cluster.

abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, Context context)

Updates an existing cluster.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The definition of the cluster that will be used to create a new cluster or replace the existing one.

Returns:

the SyncPoller<T,U> for polling of a Stream Analytics Cluster object.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginCreateOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, String ifNoneMatch, Context context)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The definition of the cluster that will be used to create a new cluster or replace the existing one.
ifMatch - The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a Stream Analytics Cluster object.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, ClusterInner cluster)

Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).

Returns:

the SyncPoller<T,U> for polling of a Stream Analytics Cluster object.

beginUpdate

public abstract SyncPoller<PollResult<ClusterInner>,ClusterInner> beginUpdate(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, Context context)

Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).
ifMatch - The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a Stream Analytics Cluster object.

createOrUpdate

public abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The definition of the cluster that will be used to create a new cluster or replace the existing one.

Returns:

a Stream Analytics Cluster object.

createOrUpdate

public abstract ClusterInner createOrUpdate(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, String ifNoneMatch, Context context)

Creates a Stream Analytics Cluster or replaces an already existing cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The definition of the cluster that will be used to create a new cluster or replace the existing one.
ifMatch - The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
context - The context to associate with this operation.

Returns:

a Stream Analytics Cluster object.

delete

public abstract void delete(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.

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.

getByResourceGroup

public abstract ClusterInner 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<ClusterInner> 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<ClusterInner> 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<ClusterInner> 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<ClusterInner> 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<ClusterInner> 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<ClusterJobInner> 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<ClusterJobInner> 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>.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterInner cluster)

Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).

Returns:

a Stream Analytics Cluster object.

update

public abstract ClusterInner update(String resourceGroupName, String clusterName, ClusterInner cluster, String ifMatch, Context context)

Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
clusterName - The name of the cluster.
cluster - The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).
ifMatch - The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
context - The context to associate with this operation.

Returns:

a Stream Analytics Cluster object.

Applies to