Package com.azure.resourcemanager.servicefabric.fluent.models

Class ClusterPropertiesUpdateParameters

java.lang.Object
com.azure.resourcemanager.servicefabric.fluent.models.ClusterPropertiesUpdateParameters
public final class ClusterPropertiesUpdateParameters extends Object
Describes the cluster resource properties that can be updated during PATCH operation.

  • Constructor Details

    • ClusterPropertiesUpdateParameters

      public ClusterPropertiesUpdateParameters()
      Creates an instance of ClusterPropertiesUpdateParameters class.

  • Method Details

    • addOnFeatures

      public List<AddOnFeatures> addOnFeatures()
      Get the addOnFeatures property: The list of add-on features to enable in the cluster.
      Returns:
      the addOnFeatures value.

    • withAddOnFeatures

      public ClusterPropertiesUpdateParameters withAddOnFeatures(List<AddOnFeatures> 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 ClusterPropertiesUpdateParameters object itself.

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

    • withCertificate

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

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

    • withCertificateCommonNames

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • clientCertificateCommonNames

      public List<ClientCertificateCommonName> 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.

    • withClientCertificateCommonNames

      public ClusterPropertiesUpdateParameters withClientCertificateCommonNames(List<ClientCertificateCommonName> 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 ClusterPropertiesUpdateParameters object itself.

    • clientCertificateThumbprints

      public List<ClientCertificateThumbprint> 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.

    • withClientCertificateThumbprints

      public ClusterPropertiesUpdateParameters withClientCertificateThumbprints(List<ClientCertificateThumbprint> 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 ClusterPropertiesUpdateParameters object itself.

    • 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](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**.
      Returns:
      the clusterCodeVersion value.

    • withClusterCodeVersion

      public ClusterPropertiesUpdateParameters 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](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**.
      Parameters:
      clusterCodeVersion - the clusterCodeVersion value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

    • eventStoreServiceEnabled

      public Boolean eventStoreServiceEnabled()
      Get the eventStoreServiceEnabled property: Indicates if the event store service is enabled.
      Returns:
      the eventStoreServiceEnabled value.

    • withEventStoreServiceEnabled

      public ClusterPropertiesUpdateParameters withEventStoreServiceEnabled(Boolean eventStoreServiceEnabled)
      Set the eventStoreServiceEnabled property: Indicates if the event store service is enabled.
      Parameters:
      eventStoreServiceEnabled - the eventStoreServiceEnabled value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

    • fabricSettings

      public List<SettingsSectionDescription> 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.

    • withFabricSettings

      public ClusterPropertiesUpdateParameters withFabricSettings(List<SettingsSectionDescription> 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 ClusterPropertiesUpdateParameters object itself.

    • nodeTypes

      public List<NodeTypeDescription> nodeTypes()
      Get the nodeTypes property: The list of node types in the cluster. This will overwrite the existing list.
      Returns:
      the nodeTypes value.

    • withNodeTypes

      public ClusterPropertiesUpdateParameters withNodeTypes(List<NodeTypeDescription> 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 ClusterPropertiesUpdateParameters object itself.

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

    • withReliabilityLevel

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • reverseProxyCertificate

      public CertificateDescription reverseProxyCertificate()
      Get the reverseProxyCertificate property: The server certificate used by reverse proxy.
      Returns:
      the reverseProxyCertificate value.

    • withReverseProxyCertificate

      public ClusterPropertiesUpdateParameters withReverseProxyCertificate(CertificateDescription reverseProxyCertificate)
      Set the reverseProxyCertificate property: The server certificate used by reverse proxy.
      Parameters:
      reverseProxyCertificate - the reverseProxyCertificate value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

    • upgradeDescription

      public ClusterUpgradePolicy upgradeDescription()
      Get the upgradeDescription property: The policy to use when upgrading the cluster.
      Returns:
      the upgradeDescription value.

    • withUpgradeDescription

      public ClusterPropertiesUpdateParameters withUpgradeDescription(ClusterUpgradePolicy upgradeDescription)
      Set the upgradeDescription property: The policy to use when upgrading the cluster.
      Parameters:
      upgradeDescription - the upgradeDescription value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

    • applicationTypeVersionsCleanupPolicy

      public ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy()
      Get the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.
      Returns:
      the applicationTypeVersionsCleanupPolicy value.

    • withApplicationTypeVersionsCleanupPolicy

      public ClusterPropertiesUpdateParameters withApplicationTypeVersionsCleanupPolicy(ApplicationTypeVersionsCleanupPolicy applicationTypeVersionsCleanupPolicy)
      Set the applicationTypeVersionsCleanupPolicy property: The policy used to clean up unused versions.
      Parameters:
      applicationTypeVersionsCleanupPolicy - the applicationTypeVersionsCleanupPolicy value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

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

    • withUpgradeMode

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

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

    • withSfZonalUpgradeMode

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

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

    • withVmssZonalUpgradeMode

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • infrastructureServiceManager

      public Boolean infrastructureServiceManager()
      Get the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.
      Returns:
      the infrastructureServiceManager value.

    • withInfrastructureServiceManager

      public ClusterPropertiesUpdateParameters withInfrastructureServiceManager(Boolean infrastructureServiceManager)
      Set the infrastructureServiceManager property: Indicates if infrastructure service manager is enabled.
      Parameters:
      infrastructureServiceManager - the infrastructureServiceManager value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

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

    • withUpgradeWave

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • upgradePauseStartTimestampUtc

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

    • withUpgradePauseStartTimestampUtc

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • upgradePauseEndTimestampUtc

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

    • withUpgradePauseEndTimestampUtc

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • waveUpgradePaused

      public Boolean waveUpgradePaused()
      Get the waveUpgradePaused property: Boolean to pause automatic runtime version upgrades to the cluster.
      Returns:
      the waveUpgradePaused value.

    • withWaveUpgradePaused

      public ClusterPropertiesUpdateParameters 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 ClusterPropertiesUpdateParameters object itself.

    • notifications

      public List<Notification> notifications()
      Get the notifications property: Indicates a list of notification channels for cluster events.
      Returns:
      the notifications value.

    • withNotifications

      public ClusterPropertiesUpdateParameters withNotifications(List<Notification> notifications)
      Set the notifications property: Indicates a list of notification channels for cluster events.
      Parameters:
      notifications - the notifications value to set.
      Returns:
      the ClusterPropertiesUpdateParameters object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.