public class ClusterUpdateParameters extends Object
Constructor and Description |
---|
ClusterUpdateParameters() |
Modifier and Type | Method and Description |
---|---|
List<AddOnFeatures> |
addOnFeatures()
Get the addOnFeatures property: The list of add-on features to enable in the cluster.
|
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.
|
List<NodeTypeDescription> |
nodeTypes()
Get the nodeTypes property: The list of node types in the cluster.
|
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.
|
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.
|
void |
validate()
Validates the instance.
|
ClusterUpdateParameters |
withAddOnFeatures(List<AddOnFeatures> addOnFeatures)
Set the addOnFeatures property: The list of add-on features to enable in the cluster.
|
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 |
withNodeTypes(List<NodeTypeDescription> nodeTypes)
Set the nodeTypes property: The list of node types in the cluster.
|
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 |
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.
|
public Map<String,String> tags()
public ClusterUpdateParameters withTags(Map<String,String> tags)
tags
- the tags value to set.public List<AddOnFeatures> addOnFeatures()
public ClusterUpdateParameters withAddOnFeatures(List<AddOnFeatures> addOnFeatures)
addOnFeatures
- the addOnFeatures value to set.public CertificateDescription certificate()
public ClusterUpdateParameters withCertificate(CertificateDescription certificate)
certificate
- the certificate value to set.public ServerCertificateCommonNames certificateCommonNames()
public ClusterUpdateParameters withCertificateCommonNames(ServerCertificateCommonNames certificateCommonNames)
certificateCommonNames
- the certificateCommonNames value to set.public List<ClientCertificateCommonName> clientCertificateCommonNames()
public ClusterUpdateParameters withClientCertificateCommonNames(List<ClientCertificateCommonName> clientCertificateCommonNames)
clientCertificateCommonNames
- the clientCertificateCommonNames value to set.public List<ClientCertificateThumbprint> clientCertificateThumbprints()
public ClusterUpdateParameters withClientCertificateThumbprints(List<ClientCertificateThumbprint> clientCertificateThumbprints)
clientCertificateThumbprints
- the clientCertificateThumbprints value to set.public String clusterCodeVersion()
public ClusterUpdateParameters withClusterCodeVersion(String clusterCodeVersion)
clusterCodeVersion
- the clusterCodeVersion value to set.public Boolean eventStoreServiceEnabled()
public ClusterUpdateParameters withEventStoreServiceEnabled(Boolean eventStoreServiceEnabled)
eventStoreServiceEnabled
- the eventStoreServiceEnabled value to set.public List<SettingsSectionDescription> fabricSettings()
public ClusterUpdateParameters withFabricSettings(List<SettingsSectionDescription> fabricSettings)
fabricSettings
- the fabricSettings value to set.public List<NodeTypeDescription> nodeTypes()
public ClusterUpdateParameters withNodeTypes(List<NodeTypeDescription> nodeTypes)
nodeTypes
- the nodeTypes value to set.public ReliabilityLevel reliabilityLevel()
- 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.
public ClusterUpdateParameters withReliabilityLevel(ReliabilityLevel reliabilityLevel)
- 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.
reliabilityLevel
- the reliabilityLevel value to set.public CertificateDescription reverseProxyCertificate()
public ClusterUpdateParameters withReverseProxyCertificate(CertificateDescription reverseProxyCertificate)
reverseProxyCertificate
- the reverseProxyCertificate value to set.public ClusterUpgradePolicy upgradeDescription()
public ClusterUpdateParameters withUpgradeDescription(ClusterUpgradePolicy upgradeDescription)
upgradeDescription
- the upgradeDescription value to set.public UpgradeMode upgradeMode()
- Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available. - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.
public ClusterUpdateParameters withUpgradeMode(UpgradeMode upgradeMode)
- Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available. - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.
upgradeMode
- the upgradeMode value to set.public void validate()
IllegalArgumentException
- thrown if the instance is not valid.Copyright © 2021 Microsoft Corporation. All rights reserved.