Interface Cluster
-
public interface Cluster
An immutable client-side representation of Cluster.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Cluster.Definition
The entirety of the Cluster definition.static interface
Cluster.DefinitionStages
The Cluster definition stages.static interface
Cluster.Update
The template for Cluster update.static interface
Cluster.UpdateStages
The Cluster update stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Integer
capacityAllocated()
Gets the capacityAllocated property: Represents the number of streaming units currently being used on the cluster.Integer
capacityAssigned()
Gets the capacityAssigned property: Represents the sum of the SUs of all streaming jobs associated with the cluster.String
clusterId()
Gets the clusterId property: Unique identifier for the cluster.OffsetDateTime
createdDate()
Gets the createdDate property: The date this cluster was created.String
etag()
Gets the etag property: The current entity tag for the cluster.String
id()
Gets the id property: Fully qualified resource Id for the resource.ClusterInner
innerModel()
Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.ClusterInner object.com.azure.core.http.rest.PagedIterable<ClusterJob>
listStreamingJobs()
Lists all of the streaming jobs in the given cluster.com.azure.core.http.rest.PagedIterable<ClusterJob>
listStreamingJobs(com.azure.core.util.Context context)
Lists all of the streaming jobs in the given cluster.String
location()
Gets the location property: The geo-location where the resource lives.String
name()
Gets the name property: The name of the resource.ClusterProvisioningState
provisioningState()
Gets the provisioningState property: The status of the cluster provisioning.Cluster
refresh()
Refreshes the resource to sync with Azure.Cluster
refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.String
regionName()
Gets the name of the resource region.ClusterSku
sku()
Gets the sku property: The SKU of the cluster.Map<String,String>
tags()
Gets the tags property: Resource tags.String
type()
Gets the type property: The type of the resource.Cluster.Update
update()
Begins update for the Cluster resource.
-
-
-
Method Detail
-
id
String id()
Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()
Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()
Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()
Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
sku
ClusterSku sku()
Gets the sku property: The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.- Returns:
- the sku value.
-
etag
String etag()
Gets the etag property: The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.- Returns:
- the etag value.
-
createdDate
OffsetDateTime createdDate()
Gets the createdDate property: The date this cluster was created.- Returns:
- the createdDate value.
-
clusterId
String clusterId()
Gets the clusterId property: Unique identifier for the cluster.- Returns:
- the clusterId value.
-
provisioningState
ClusterProvisioningState provisioningState()
Gets the provisioningState property: The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled.- Returns:
- the provisioningState value.
-
capacityAllocated
Integer capacityAllocated()
Gets the capacityAllocated property: Represents the number of streaming units currently being used on the cluster.- Returns:
- the capacityAllocated value.
-
capacityAssigned
Integer capacityAssigned()
Gets the capacityAssigned property: Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.- Returns:
- the capacityAssigned value.
-
region
com.azure.core.management.Region region()
Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()
Gets the name of the resource region.- Returns:
- the name of the resource region.
-
innerModel
ClusterInner innerModel()
Gets the inner com.azure.resourcemanager.streamanalytics.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
Cluster refresh()
Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Cluster refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
listStreamingJobs
com.azure.core.http.rest.PagedIterable<ClusterJob> listStreamingJobs()
Lists all of the streaming jobs in the given cluster.- Returns:
- a list of streaming jobs.
- 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.
-
listStreamingJobs
com.azure.core.http.rest.PagedIterable<ClusterJob> listStreamingJobs(com.azure.core.util.Context context)
Lists all of the streaming jobs in the given cluster.- Parameters:
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.
-
-