Interface Clusters


  • public interface Clusters
    Resource collection API of Clusters.
    • Method Detail

      • getByResourceGroup

        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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<Cluster> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                  String clusterName,
                                                                                  com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteByResourceGroup

        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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • delete

        void delete​(String resourceGroupName,
                    String clusterName,
                    com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • list

        com.azure.core.http.rest.PagedIterable<Cluster> list()
        Lists all of the clusters in the given subscription.
        Returns:
        a list of clusters populated by a 'list' operation.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • list

        com.azure.core.http.rest.PagedIterable<Cluster> list​(com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<Cluster> 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<Cluster> listByResourceGroup​(String resourceGroupName,
                                                                            com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listStreamingJobs

        com.azure.core.http.rest.PagedIterable<ClusterJob> 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listStreamingJobs

        com.azure.core.http.rest.PagedIterable<ClusterJob> listStreamingJobs​(String resourceGroupName,
                                                                             String clusterName,
                                                                             com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getById

        Cluster getById​(String id)
        Gets information about the specified cluster.
        Parameters:
        id - the resource ID.
        Returns:
        information about the specified cluster.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<Cluster> getByIdWithResponse​(String id,
                                                                       com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteById

        void deleteById​(String id)
        Deletes the specified cluster.
        Parameters:
        id - the resource ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteByIdWithResponse

        void deleteByIdWithResponse​(String id,
                                    com.azure.core.util.Context context)
        Deletes the specified cluster.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • define

        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.