ClusterUpdateParameters 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.ClusterUpdateParameters

public final class ClusterUpdateParameters

Cluster update request.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
List<AddOnFeatures>	addOnFeatures() Get the addOnFeatures property: The list of add-on features to enable in the cluster.
ApplicationTypeVersionsCleanupPolicy	applicationTypeVersionsCleanupPolicy() Get the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.
CertificateDescription	certificate() Get the certificate property: The certificate to use for securing the cluster.
ServerCertificateCommonNames	certificateCommonNames() Get the certificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.
List<ClientCertificateCommonName>	clientCertificateCommonNames() Get the clientCertificateCommonNames property: The list of client certificates referenced by common name that are allowed to manage the cluster.
List<ClientCertificateThumbprint>	clientCertificateThumbprints() Get the clientCertificateThumbprints property: The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
String	clusterCodeVersion() Get the clusterCodeVersion property: The Service Fabric runtime version of the cluster.
Boolean	eventStoreServiceEnabled() Get the eventStoreServiceEnabled property: Indicates if the event store service is enabled.
List<SettingsSectionDescription>	fabricSettings() Get the fabricSettings property: The list of custom fabric settings to configure the cluster.
Boolean	infrastructureServiceManager() Get the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.
List<NodeTypeDescription>	nodeTypes() Get the nodeTypes property: The list of node types in the cluster.
List<Notification>	notifications() Get the notifications property: Indicates a list of notification channels for cluster events.
ReliabilityLevel	reliabilityLevel() Get the reliabilityLevel property: The reliability level sets the replica set size of system services.
CertificateDescription	reverseProxyCertificate() Get the reverseProxyCertificate property: The server certificate used by reverse proxy.
SfZonalUpgradeMode	sfZonalUpgradeMode() Get the sfZonalUpgradeMode property: This property controls the logical grouping of VMs in upgrade domains (UDs).
Map<String,String>	tags() Get the tags property: Cluster update parameters.
ClusterUpgradePolicy	upgradeDescription() Get the upgradeDescription property: The policy to use when upgrading the cluster.
UpgradeMode	upgradeMode() Get the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.
OffsetDateTime	upgradePauseEndTimestampUtc() Get the upgradePauseEndTimestampUtc property: The end timestamp of pause runtime version upgrades on the cluster (UTC).
OffsetDateTime	upgradePauseStartTimestampUtc() Get the upgradePauseStartTimestampUtc property: The start timestamp to pause runtime version upgrades on the cluster (UTC).
ClusterUpgradeCadence	upgradeWave() Get the upgradeWave property: Indicates when new cluster runtime version upgrades will be applied after they are released.
void	validate() Validates the instance.
VmssZonalUpgradeMode	vmssZonalUpgradeMode() Get the vmssZonalUpgradeMode property: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added.
Boolean	waveUpgradePaused() Get the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.
ClusterUpdateParameters	withAddOnFeatures(List<AddOnFeatures> addOnFeatures) Set the addOnFeatures property: The list of add-on features to enable in the cluster.
ClusterUpdateParameters	withApplicationTypeVersionsCleanupPolicy(ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy) Set the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.
ClusterUpdateParameters	withCertificate(CertificateDescription certificate) Set the certificate property: The certificate to use for securing the cluster.
ClusterUpdateParameters	withCertificateCommonNames(ServerCertificateCommonNames certificateCommonNames) Set the certificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.
ClusterUpdateParameters	withClientCertificateCommonNames(List<ClientCertificateCommonName> clientCertificateCommonNames) Set the clientCertificateCommonNames property: The list of client certificates referenced by common name that are allowed to manage the cluster.
ClusterUpdateParameters	withClientCertificateThumbprints(List<ClientCertificateThumbprint> clientCertificateThumbprints) Set the clientCertificateThumbprints property: The list of client certificates referenced by thumbprint that are allowed to manage the cluster.
ClusterUpdateParameters	withClusterCodeVersion(String clusterCodeVersion) Set the clusterCodeVersion property: The Service Fabric runtime version of the cluster.
ClusterUpdateParameters	withEventStoreServiceEnabled(Boolean eventStoreServiceEnabled) Set the eventStoreServiceEnabled property: Indicates if the event store service is enabled.
ClusterUpdateParameters	withFabricSettings(List<SettingsSectionDescription> fabricSettings) Set the fabricSettings property: The list of custom fabric settings to configure the cluster.
ClusterUpdateParameters	withInfrastructureServiceManager(Boolean infrastructureServiceManager) Set the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.
ClusterUpdateParameters	withNodeTypes(List<NodeTypeDescription> nodeTypes) Set the nodeTypes property: The list of node types in the cluster.
ClusterUpdateParameters	withNotifications(List<Notification> notifications) Set the notifications property: Indicates a list of notification channels for cluster events.
ClusterUpdateParameters	withReliabilityLevel(ReliabilityLevel reliabilityLevel) Set the reliabilityLevel property: The reliability level sets the replica set size of system services.
ClusterUpdateParameters	withReverseProxyCertificate(CertificateDescription reverseProxyCertificate) Set the reverseProxyCertificate property: The server certificate used by reverse proxy.
ClusterUpdateParameters	withSfZonalUpgradeMode(SfZonalUpgradeMode sfZonalUpgradeMode) Set the sfZonalUpgradeMode property: This property controls the logical grouping of VMs in upgrade domains (UDs).
ClusterUpdateParameters	withTags(Map<String,String> tags) Set the tags property: Cluster update parameters.
ClusterUpdateParameters	withUpgradeDescription(ClusterUpgradePolicy upgradeDescription) Set the upgradeDescription property: The policy to use when upgrading the cluster.
ClusterUpdateParameters	withUpgradeMode(UpgradeMode upgradeMode) Set the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.
ClusterUpdateParameters	withUpgradePauseEndTimestampUtc(OffsetDateTime upgradePauseEndTimestampUtc) Set the upgradePauseEndTimestampUtc property: The end timestamp of pause runtime version upgrades on the cluster (UTC).
ClusterUpdateParameters	withUpgradePauseStartTimestampUtc(OffsetDateTime upgradePauseStartTimestampUtc) Set the upgradePauseStartTimestampUtc property: The start timestamp to pause runtime version upgrades on the cluster (UTC).
ClusterUpdateParameters	withUpgradeWave(ClusterUpgradeCadence upgradeWave) Set the upgradeWave property: Indicates when new cluster runtime version upgrades will be applied after they are released.
ClusterUpdateParameters	withVmssZonalUpgradeMode(VmssZonalUpgradeMode vmssZonalUpgradeMode) Set the vmssZonalUpgradeMode property: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added.
ClusterUpdateParameters	withWaveUpgradePaused(Boolean waveUpgradePaused) Set the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClusterUpdateParameters

public ClusterUpdateParameters()

Creates an instance of ClusterUpdateParameters class.

Method Details

addOnFeatures

public List addOnFeatures()

Get the addOnFeatures property: The list of add-on features to enable in the cluster.

Returns:

the addOnFeatures value.

applicationTypeVersionsCleanupPolicy

public ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy()

Get the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.

Returns:

the applicationTypeVersionsCleanupPolicy value.

certificate

public CertificateDescription certificate()

Get the certificate property: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.

Returns:

the certificate value.

certificateCommonNames

public ServerCertificateCommonNames certificateCommonNames()

Get the certificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.

Returns:

the certificateCommonNames value.

clientCertificateCommonNames

public List clientCertificateCommonNames()

Get the clientCertificateCommonNames property: The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.

Returns:

the clientCertificateCommonNames value.

clientCertificateThumbprints

public List clientCertificateThumbprints()

Get the clientCertificateThumbprints property: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.

Returns:

the clientCertificateThumbprints value.

clusterCodeVersion

public String clusterCodeVersion()

Get the clusterCodeVersion property: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**.

Returns:

the clusterCodeVersion value.

eventStoreServiceEnabled

public Boolean eventStoreServiceEnabled()

Get the eventStoreServiceEnabled property: Indicates if the event store service is enabled.

Returns:

the eventStoreServiceEnabled value.

fabricSettings

public List fabricSettings()

Get the fabricSettings property: The list of custom fabric settings to configure the cluster. This will overwrite the existing list.

Returns:

the fabricSettings value.

infrastructureServiceManager

public Boolean infrastructureServiceManager()

Get the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.

Returns:

the infrastructureServiceManager value.

nodeTypes

public List nodeTypes()

Get the nodeTypes property: The list of node types in the cluster. This will overwrite the existing list.

Returns:

the nodeTypes value.

notifications

public List notifications()

Get the notifications property: Indicates a list of notification channels for cluster events.

Returns:

the notifications value.

reliabilityLevel

public ReliabilityLevel reliabilityLevel()

Get the reliabilityLevel property: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9.

Returns:

the reliabilityLevel value.

reverseProxyCertificate

public CertificateDescription reverseProxyCertificate()

Get the reverseProxyCertificate property: The server certificate used by reverse proxy.

Returns:

the reverseProxyCertificate value.

sfZonalUpgradeMode

public SfZonalUpgradeMode sfZonalUpgradeMode()

Get the sfZonalUpgradeMode property: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster.

Returns:

the sfZonalUpgradeMode value.

tags

public Map tags()

Get the tags property: Cluster update parameters.

Returns:

the tags value.

upgradeDescription

public ClusterUpgradePolicy upgradeDescription()

Get the upgradeDescription property: The policy to use when upgrading the cluster.

Returns:

the upgradeDescription value.

upgradeMode

public UpgradeMode upgradeMode()

Get the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.

Returns:

the upgradeMode value.

upgradePauseEndTimestampUtc

public OffsetDateTime upgradePauseEndTimestampUtc()

Get the upgradePauseEndTimestampUtc property: The end timestamp of pause runtime version upgrades on the cluster (UTC).

Returns:

the upgradePauseEndTimestampUtc value.

upgradePauseStartTimestampUtc

public OffsetDateTime upgradePauseStartTimestampUtc()

Get the upgradePauseStartTimestampUtc property: The start timestamp to pause runtime version upgrades on the cluster (UTC).

Returns:

the upgradePauseStartTimestampUtc value.

upgradeWave

public ClusterUpgradeCadence upgradeWave()

Get the upgradeWave property: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'.

Returns:

the upgradeWave value.

validate

public void validate()

Validates the instance.

vmssZonalUpgradeMode

public VmssZonalUpgradeMode vmssZonalUpgradeMode()

Get the vmssZonalUpgradeMode property: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added.

Returns:

the vmssZonalUpgradeMode value.

waveUpgradePaused

public Boolean waveUpgradePaused()

Get the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.

Returns:

the waveUpgradePaused value.

withAddOnFeatures

public ClusterUpdateParameters withAddOnFeatures(List addOnFeatures)

Set the addOnFeatures property: The list of add-on features to enable in the cluster.

Parameters:

addOnFeatures - the addOnFeatures value to set.

Returns:

the ClusterUpdateParameters object itself.

withApplicationTypeVersionsCleanupPolicy

public ClusterUpdateParameters withApplicationTypeVersionsCleanupPolicy(ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy)

Set the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.

Parameters:

applicationTypeVersionsCleanupPolicy - the applicationTypeVersionsCleanupPolicy value to set.

Returns:

the ClusterUpdateParameters object itself.

withCertificate

public ClusterUpdateParameters withCertificate(CertificateDescription certificate)

Set the certificate property: The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.

Parameters:

certificate - the certificate value to set.

Returns:

the ClusterUpdateParameters object itself.

withCertificateCommonNames

public ClusterUpdateParameters withCertificateCommonNames(ServerCertificateCommonNames certificateCommonNames)

Set the certificateCommonNames property: Describes a list of server certificates referenced by common name that are used to secure the cluster.

Parameters:

certificateCommonNames - the certificateCommonNames value to set.

Returns:

the ClusterUpdateParameters object itself.

withClientCertificateCommonNames

public ClusterUpdateParameters withClientCertificateCommonNames(List clientCertificateCommonNames)

Set the clientCertificateCommonNames property: The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.

Parameters:

clientCertificateCommonNames - the clientCertificateCommonNames value to set.

Returns:

the ClusterUpdateParameters object itself.

withClientCertificateThumbprints

public ClusterUpdateParameters withClientCertificateThumbprints(List clientCertificateThumbprints)

Set the clientCertificateThumbprints property: The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.

Parameters:

clientCertificateThumbprints - the clientCertificateThumbprints value to set.

Returns:

the ClusterUpdateParameters object itself.

withClusterCodeVersion

public ClusterUpdateParameters withClusterCodeVersion(String clusterCodeVersion)

Set the clusterCodeVersion property: The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](https://learn.microsoft.com/rest/api/servicefabric/cluster-versions/list). To get the list of available version for existing clusters use **availableClusterVersions**.

Parameters:

clusterCodeVersion - the clusterCodeVersion value to set.

Returns:

the ClusterUpdateParameters object itself.

withEventStoreServiceEnabled

public ClusterUpdateParameters withEventStoreServiceEnabled(Boolean eventStoreServiceEnabled)

Set the eventStoreServiceEnabled property: Indicates if the event store service is enabled.

Parameters:

eventStoreServiceEnabled - the eventStoreServiceEnabled value to set.

Returns:

the ClusterUpdateParameters object itself.

withFabricSettings

public ClusterUpdateParameters withFabricSettings(List fabricSettings)

Set the fabricSettings property: The list of custom fabric settings to configure the cluster. This will overwrite the existing list.

Parameters:

fabricSettings - the fabricSettings value to set.

Returns:

the ClusterUpdateParameters object itself.

withInfrastructureServiceManager

public ClusterUpdateParameters withInfrastructureServiceManager(Boolean infrastructureServiceManager)

Set the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.

Parameters:

infrastructureServiceManager - the infrastructureServiceManager value to set.

Returns:

the ClusterUpdateParameters object itself.

withNodeTypes

public ClusterUpdateParameters withNodeTypes(List nodeTypes)

Set the nodeTypes property: The list of node types in the cluster. This will overwrite the existing list.

Parameters:

nodeTypes - the nodeTypes value to set.

Returns:

the ClusterUpdateParameters object itself.

withNotifications

public ClusterUpdateParameters withNotifications(List notifications)

Set the notifications property: Indicates a list of notification channels for cluster events.

Parameters:

notifications - the notifications value to set.

Returns:

the ClusterUpdateParameters object itself.

withReliabilityLevel

public ClusterUpdateParameters withReliabilityLevel(ReliabilityLevel reliabilityLevel)

Set the reliabilityLevel property: The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity). - None - Run the System services with a target replica set count of 1. This should only be used for test clusters. - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters. - Silver - Run the System services with a target replica set count of 5. - Gold - Run the System services with a target replica set count of 7. - Platinum - Run the System services with a target replica set count of 9.

Parameters:

reliabilityLevel - the reliabilityLevel value to set.

Returns:

the ClusterUpdateParameters object itself.

withReverseProxyCertificate

public ClusterUpdateParameters withReverseProxyCertificate(CertificateDescription reverseProxyCertificate)

Set the reverseProxyCertificate property: The server certificate used by reverse proxy.

Parameters:

reverseProxyCertificate - the reverseProxyCertificate value to set.

Returns:

the ClusterUpdateParameters object itself.

withSfZonalUpgradeMode

public ClusterUpdateParameters withSfZonalUpgradeMode(SfZonalUpgradeMode sfZonalUpgradeMode)

Set the sfZonalUpgradeMode property: This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster.

Parameters:

sfZonalUpgradeMode - the sfZonalUpgradeMode value to set.

Returns:

the ClusterUpdateParameters object itself.

withTags

public ClusterUpdateParameters withTags(Map tags)

Set the tags property: Cluster update parameters.

Parameters:

tags - the tags value to set.

Returns:

the ClusterUpdateParameters object itself.

withUpgradeDescription

public ClusterUpdateParameters withUpgradeDescription(ClusterUpgradePolicy upgradeDescription)

Set the upgradeDescription property: The policy to use when upgrading the cluster.

Parameters:

upgradeDescription - the upgradeDescription value to set.

Returns:

the ClusterUpdateParameters object itself.

withUpgradeMode

public ClusterUpdateParameters withUpgradeMode(UpgradeMode upgradeMode)

Set the upgradeMode property: The upgrade mode of the cluster when new Service Fabric runtime version is available.

Parameters:

upgradeMode - the upgradeMode value to set.

Returns:

the ClusterUpdateParameters object itself.

withUpgradePauseEndTimestampUtc

public ClusterUpdateParameters withUpgradePauseEndTimestampUtc(OffsetDateTime upgradePauseEndTimestampUtc)

Set the upgradePauseEndTimestampUtc property: The end timestamp of pause runtime version upgrades on the cluster (UTC).

Parameters:

upgradePauseEndTimestampUtc - the upgradePauseEndTimestampUtc value to set.

Returns:

the ClusterUpdateParameters object itself.

withUpgradePauseStartTimestampUtc

public ClusterUpdateParameters withUpgradePauseStartTimestampUtc(OffsetDateTime upgradePauseStartTimestampUtc)

Set the upgradePauseStartTimestampUtc property: The start timestamp to pause runtime version upgrades on the cluster (UTC).

Parameters:

upgradePauseStartTimestampUtc - the upgradePauseStartTimestampUtc value to set.

Returns:

the ClusterUpdateParameters object itself.

withUpgradeWave

public ClusterUpdateParameters withUpgradeWave(ClusterUpgradeCadence upgradeWave)

Set the upgradeWave property: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **upgradeMode** is set to 'Automatic'.

Parameters:

upgradeWave - the upgradeWave value to set.

Returns:

the ClusterUpdateParameters object itself.

withVmssZonalUpgradeMode

public ClusterUpdateParameters withVmssZonalUpgradeMode(VmssZonalUpgradeMode vmssZonalUpgradeMode)

Set the vmssZonalUpgradeMode property: This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added.

Parameters:

vmssZonalUpgradeMode - the vmssZonalUpgradeMode value to set.

Returns:

the ClusterUpdateParameters object itself.

withWaveUpgradePaused

public ClusterUpdateParameters withWaveUpgradePaused(Boolean waveUpgradePaused)

Set the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.

Parameters:

waveUpgradePaused - the waveUpgradePaused value to set.

Returns:

the ClusterUpdateParameters object itself.