NodeTypeDescription Class

Package:

com.azure.resourcemanager.servicefabric.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-servicefabric:1.0.0-beta.4

• java.lang.Object
• • com.azure.resourcemanager.servicefabric.models.NodeTypeDescription

public final class NodeTypeDescription

Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.

Constructor Summary

Constructor	Description
NodeTypeDescription()	Creates an instance of NodeTypeDescription class.

Method Summary

Modifier and Type	Method and Description
EndpointRangeDescription	applicationPorts() Get the applicationPorts property: The range of ports from which cluster assigned port to Service Fabric applications.
Map<String,String>	capacities() Get the capacities property: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.
int	clientConnectionEndpointPort() Get the clientConnectionEndpointPort property: The TCP cluster management endpoint port.
DurabilityLevel	durabilityLevel() Get the durabilityLevel property: The durability level of the node type.
EndpointRangeDescription	ephemeralPorts() Get the ephemeralPorts property: The range of ephemeral ports that nodes in this node type should be configured with.
int	httpGatewayEndpointPort() Get the httpGatewayEndpointPort property: The HTTP cluster management endpoint port.
boolean	isPrimary() Get the isPrimary property: The node type on which system services will run.
Boolean	isStateless() Get the isStateless property: Indicates if the node type can only host Stateless workloads.
Boolean	multipleAvailabilityZones() Get the multipleAvailabilityZones property: Indicates if the node type is enabled to support multiple zones.
String	name() Get the name property: The name of the node type.
Map<String,String>	placementProperties() Get the placementProperties property: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.
Integer	reverseProxyEndpointPort() Get the reverseProxyEndpointPort property: The endpoint used by reverse proxy.
void	validate() Validates the instance.
int	vmInstanceCount() Get the vmInstanceCount property: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType.
NodeTypeDescription	withApplicationPorts(EndpointRangeDescription applicationPorts) Set the applicationPorts property: The range of ports from which cluster assigned port to Service Fabric applications.
NodeTypeDescription	withCapacities(Map<String,String> capacities) Set the capacities property: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.
NodeTypeDescription	withClientConnectionEndpointPort(int clientConnectionEndpointPort) Set the clientConnectionEndpointPort property: The TCP cluster management endpoint port.
NodeTypeDescription	withDurabilityLevel(DurabilityLevel durabilityLevel) Set the durabilityLevel property: The durability level of the node type.
NodeTypeDescription	withEphemeralPorts(EndpointRangeDescription ephemeralPorts) Set the ephemeralPorts property: The range of ephemeral ports that nodes in this node type should be configured with.
NodeTypeDescription	withHttpGatewayEndpointPort(int httpGatewayEndpointPort) Set the httpGatewayEndpointPort property: The HTTP cluster management endpoint port.
NodeTypeDescription	withIsPrimary(boolean isPrimary) Set the isPrimary property: The node type on which system services will run.
NodeTypeDescription	withIsStateless(Boolean isStateless) Set the isStateless property: Indicates if the node type can only host Stateless workloads.
NodeTypeDescription	withMultipleAvailabilityZones(Boolean multipleAvailabilityZones) Set the multipleAvailabilityZones property: Indicates if the node type is enabled to support multiple zones.
NodeTypeDescription	withName(String name) Set the name property: The name of the node type.
NodeTypeDescription	withPlacementProperties(Map<String,String> placementProperties) Set the placementProperties property: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.
NodeTypeDescription	withReverseProxyEndpointPort(Integer reverseProxyEndpointPort) Set the reverseProxyEndpointPort property: The endpoint used by reverse proxy.
NodeTypeDescription	withVmInstanceCount(int vmInstanceCount) Set the vmInstanceCount property: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

NodeTypeDescription

public NodeTypeDescription()

Creates an instance of NodeTypeDescription class.

Method Details

applicationPorts

public EndpointRangeDescription applicationPorts()

Get the applicationPorts property: The range of ports from which cluster assigned port to Service Fabric applications.

Returns:

the applicationPorts value.

capacities

public Map capacities()

Get the capacities property: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.

Returns:

the capacities value.

clientConnectionEndpointPort

public int clientConnectionEndpointPort()

Get the clientConnectionEndpointPort property: The TCP cluster management endpoint port.

Returns:

the clientConnectionEndpointPort value.

durabilityLevel

public DurabilityLevel durabilityLevel()

Get the durabilityLevel property: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.

Returns:

the durabilityLevel value.

ephemeralPorts

public EndpointRangeDescription ephemeralPorts()

Get the ephemeralPorts property: The range of ephemeral ports that nodes in this node type should be configured with.

Returns:

the ephemeralPorts value.

httpGatewayEndpointPort

public int httpGatewayEndpointPort()

Get the httpGatewayEndpointPort property: The HTTP cluster management endpoint port.

Returns:

the httpGatewayEndpointPort value.

isPrimary

public boolean isPrimary()

Get the isPrimary property: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.

Returns:

the isPrimary value.

isStateless

public Boolean isStateless()

Get the isStateless property: Indicates if the node type can only host Stateless workloads.

Returns:

the isStateless value.

multipleAvailabilityZones

public Boolean multipleAvailabilityZones()

Get the multipleAvailabilityZones property: Indicates if the node type is enabled to support multiple zones.

Returns:

the multipleAvailabilityZones value.

name

public String name()

Get the name property: The name of the node type.

Returns:

the name value.

placementProperties

public Map placementProperties()

Get the placementProperties property: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.

Returns:

the placementProperties value.

reverseProxyEndpointPort

public Integer reverseProxyEndpointPort()

Get the reverseProxyEndpointPort property: The endpoint used by reverse proxy.

Returns:

the reverseProxyEndpointPort value.

validate

public void validate()

Validates the instance.

vmInstanceCount

public int vmInstanceCount()

Get the vmInstanceCount property: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation.

Returns:

the vmInstanceCount value.

withApplicationPorts

public NodeTypeDescription withApplicationPorts(EndpointRangeDescription applicationPorts)

Set the applicationPorts property: The range of ports from which cluster assigned port to Service Fabric applications.

Parameters:

applicationPorts - the applicationPorts value to set.

Returns:

the NodeTypeDescription object itself.

withCapacities

public NodeTypeDescription withCapacities(Map capacities)

Set the capacities property: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.

Parameters:

capacities - the capacities value to set.

Returns:

the NodeTypeDescription object itself.

withClientConnectionEndpointPort

public NodeTypeDescription withClientConnectionEndpointPort(int clientConnectionEndpointPort)

Set the clientConnectionEndpointPort property: The TCP cluster management endpoint port.

Parameters:

clientConnectionEndpointPort - the clientConnectionEndpointPort value to set.

Returns:

the NodeTypeDescription object itself.

withDurabilityLevel

public NodeTypeDescription withDurabilityLevel(DurabilityLevel durabilityLevel)

Set the durabilityLevel property: The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - Bronze - No privileges. This is the default. - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD. - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.

Parameters:

durabilityLevel - the durabilityLevel value to set.

Returns:

the NodeTypeDescription object itself.

withEphemeralPorts

public NodeTypeDescription withEphemeralPorts(EndpointRangeDescription ephemeralPorts)

Set the ephemeralPorts property: The range of ephemeral ports that nodes in this node type should be configured with.

Parameters:

ephemeralPorts - the ephemeralPorts value to set.

Returns:

the NodeTypeDescription object itself.

withHttpGatewayEndpointPort

public NodeTypeDescription withHttpGatewayEndpointPort(int httpGatewayEndpointPort)

Set the httpGatewayEndpointPort property: The HTTP cluster management endpoint port.

Parameters:

httpGatewayEndpointPort - the httpGatewayEndpointPort value to set.

Returns:

the NodeTypeDescription object itself.

withIsPrimary

public NodeTypeDescription withIsPrimary(boolean isPrimary)

Set the isPrimary property: The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.

Parameters:

isPrimary - the isPrimary value to set.

Returns:

the NodeTypeDescription object itself.

withIsStateless

public NodeTypeDescription withIsStateless(Boolean isStateless)

Set the isStateless property: Indicates if the node type can only host Stateless workloads.

Parameters:

isStateless - the isStateless value to set.

Returns:

the NodeTypeDescription object itself.

withMultipleAvailabilityZones

public NodeTypeDescription withMultipleAvailabilityZones(Boolean multipleAvailabilityZones)

Set the multipleAvailabilityZones property: Indicates if the node type is enabled to support multiple zones.

Parameters:

multipleAvailabilityZones - the multipleAvailabilityZones value to set.

Returns:

the NodeTypeDescription object itself.

withName

public NodeTypeDescription withName(String name)

Set the name property: The name of the node type.

Parameters:

name - the name value to set.

Returns:

the NodeTypeDescription object itself.

withPlacementProperties

public NodeTypeDescription withPlacementProperties(Map placementProperties)

Set the placementProperties property: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.

Parameters:

placementProperties - the placementProperties value to set.

Returns:

the NodeTypeDescription object itself.

withReverseProxyEndpointPort

public NodeTypeDescription withReverseProxyEndpointPort(Integer reverseProxyEndpointPort)

Set the reverseProxyEndpointPort property: The endpoint used by reverse proxy.

Parameters:

reverseProxyEndpointPort - the reverseProxyEndpointPort value to set.

Returns:

the NodeTypeDescription object itself.

withVmInstanceCount

public NodeTypeDescription withVmInstanceCount(int vmInstanceCount)

Set the vmInstanceCount property: VMInstanceCount should be 1 to n, where n indicates the number of VM instances corresponding to this nodeType. VMInstanceCount = 0 can be done only in these scenarios: NodeType is a secondary nodeType. Durability = Bronze or Durability >= Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation.

Parameters:

vmInstanceCount - the vmInstanceCount value to set.

Returns:

the NodeTypeDescription object itself.