Interface Cluster
public interface Cluster
An immutable client-side representation of Cluster.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the Cluster definition.static interfaceThe Cluster definition stages.static interfaceThe template for Cluster update.static interfaceThe Cluster update stages. -
Method Summary
Modifier and TypeMethodDescriptionid()Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.hdinsight.containers.fluent.models.ClusterInner object.location()Gets the location property: The geo-location where the resource lives.name()Gets the name property: The name of the resource.Gets the properties property: Gets or sets the properties.refresh()Refreshes the resource to sync with Azure.refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Regionregion()Gets the region of the resource.Gets the name of the resource region.resize(ClusterResizeData clusterResizeRequest) Resize an existing Cluster.resize(ClusterResizeData clusterResizeRequest, com.azure.core.util.Context context) Resize an existing Cluster.Gets the name of the resource group.com.azure.core.management.SystemDataGets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()Gets the tags property: Resource tags.type()Gets the type property: The type of the resource.update()Begins update for the Cluster resource.upgrade(ClusterUpgrade clusterUpgradeRequest) Upgrade a cluster.upgrade(ClusterUpgrade clusterUpgradeRequest, com.azure.core.util.Context context) Upgrade a cluster.upgradeManualRollback(ClusterUpgradeRollback clusterRollbackUpgradeRequest) Manual rollback upgrade for a cluster.upgradeManualRollback(ClusterUpgradeRollback clusterRollbackUpgradeRequest, com.azure.core.util.Context context) Manual rollback upgrade for a cluster.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
-
type
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
-
properties
ClusterResourceProperties properties()Gets the properties property: Gets or sets the properties. Define cluster specific properties.- Returns:
- the properties value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
ClusterInner innerModel()Gets the inner com.azure.resourcemanager.hdinsight.containers.fluent.models.ClusterInner object.- Returns:
- the inner object.
-
update
Cluster.Update update()Begins update for the Cluster resource.- Returns:
- the stage of resource update.
-
refresh
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-
upgrade
Upgrade a cluster.- Parameters:
clusterUpgradeRequest- Upgrade a cluster.- Returns:
- 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.
-
upgrade
Upgrade a cluster.- Parameters:
clusterUpgradeRequest- Upgrade a cluster.context- The context to associate with this operation.- Returns:
- 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.
-
upgradeManualRollback
Manual rollback upgrade for a cluster.- Parameters:
clusterRollbackUpgradeRequest- Manual rollback upgrade for a cluster.- Returns:
- 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.
-
upgradeManualRollback
Cluster upgradeManualRollback(ClusterUpgradeRollback clusterRollbackUpgradeRequest, com.azure.core.util.Context context) Manual rollback upgrade for a cluster.- Parameters:
clusterRollbackUpgradeRequest- Manual rollback upgrade for a cluster.context- The context to associate with this operation.- Returns:
- 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.
-
resize
Resize an existing Cluster.- Parameters:
clusterResizeRequest- Resize a cluster.- Returns:
- 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.
-
resize
Resize an existing Cluster.- Parameters:
clusterResizeRequest- Resize a cluster.context- The context to associate with this operation.- Returns:
- 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.
-