Google Kubernetes Engine v1 API - Class ClusterUpdate (3.5.0)

public sealed class ClusterUpdate : IMessage<ClusterUpdate>, IEquatable<ClusterUpdate>, IDeepCloneable<ClusterUpdate>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Kubernetes Engine v1 API class ClusterUpdate.

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Inheritance

Object > ClusterUpdate

Implements

IMessage<ClusterUpdate>, IEquatable<ClusterUpdate>, IDeepCloneable<ClusterUpdate>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Constructors

ClusterUpdate()

public ClusterUpdate()

ClusterUpdate(ClusterUpdate)

public ClusterUpdate(ClusterUpdate other)

Parameter
Name	Description
`other`	`ClusterUpdate`

Properties

DesiredAddonsConfig

public AddonsConfig DesiredAddonsConfig { get; set; }

Configurations for the various addons available to run in the cluster.

Property Value
Type	Description
`AddonsConfig`

DesiredAuthenticatorGroupsConfig

public AuthenticatorGroupsConfig DesiredAuthenticatorGroupsConfig { get; set; }

The desired authenticator groups config for the cluster.

Property Value
Type	Description
`AuthenticatorGroupsConfig`

DesiredBinaryAuthorization

public BinaryAuthorization DesiredBinaryAuthorization { get; set; }

The desired configuration options for the Binary Authorization feature.

Property Value
Type	Description
`BinaryAuthorization`

DesiredClusterAutoscaling

public ClusterAutoscaling DesiredClusterAutoscaling { get; set; }

Cluster-level autoscaling configuration.

Property Value
Type	Description
`ClusterAutoscaling`

DesiredCostManagementConfig

public CostManagementConfig DesiredCostManagementConfig { get; set; }

The desired configuration for the fine-grained cost management feature.

Property Value
Type	Description
`CostManagementConfig`

DesiredDatabaseEncryption

public DatabaseEncryption DesiredDatabaseEncryption { get; set; }

Configuration of etcd encryption.

Property Value
Type	Description
`DatabaseEncryption`

DesiredDatapathProvider

public DatapathProvider DesiredDatapathProvider { get; set; }

The desired datapath provider for the cluster.

Property Value
Type	Description
`DatapathProvider`

DesiredDefaultSnatStatus

public DefaultSnatStatus DesiredDefaultSnatStatus { get; set; }

The desired status of whether to disable default sNAT for this cluster.

Property Value
Type	Description
`DefaultSnatStatus`

DesiredDnsConfig

public DNSConfig DesiredDnsConfig { get; set; }

DNSConfig contains clusterDNS config for this cluster.

Property Value
Type	Description
`DNSConfig`

DesiredEnablePrivateEndpoint

public bool DesiredEnablePrivateEndpoint { get; set; }

Enable/Disable private endpoint for the cluster's master.

Property Value
Type	Description
`Boolean`

DesiredGatewayApiConfig

public GatewayAPIConfig DesiredGatewayApiConfig { get; set; }

The desired config of Gateway API on this cluster.

Property Value
Type	Description
`GatewayAPIConfig`

DesiredGcfsConfig

public GcfsConfig DesiredGcfsConfig { get; set; }

The desired GCFS config for the cluster

Property Value
Type	Description
`GcfsConfig`

DesiredIdentityServiceConfig

public IdentityServiceConfig DesiredIdentityServiceConfig { get; set; }

The desired Identity Service component configuration.

Property Value
Type	Description
`IdentityServiceConfig`

DesiredImageType

public string DesiredImageType { get; set; }

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Property Value
Type	Description
`String`

DesiredIntraNodeVisibilityConfig

public IntraNodeVisibilityConfig DesiredIntraNodeVisibilityConfig { get; set; }

The desired config of Intra-node visibility.

Property Value
Type	Description
`IntraNodeVisibilityConfig`

DesiredL4IlbSubsettingConfig

public ILBSubsettingConfig DesiredL4IlbSubsettingConfig { get; set; }

The desired L4 Internal Load Balancer Subsetting configuration.

Property Value
Type	Description
`ILBSubsettingConfig`

DesiredLocations

public RepeatedField<string> DesiredLocations { get; }

The desired list of Google Compute Engine zones in which the cluster's nodes should be located.

This list must always include the cluster's primary zone.

Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

Property Value
Type	Description
`RepeatedField<String>`

DesiredLoggingConfig

public LoggingConfig DesiredLoggingConfig { get; set; }

The desired logging configuration.

Property Value
Type	Description
`LoggingConfig`

DesiredLoggingService

public string DesiredLoggingService { get; set; }

The logging service the cluster should use to write logs. Currently available options:

logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
none - no logs will be exported from the cluster.

If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

Property Value
Type	Description
`String`

DesiredMasterAuthorizedNetworksConfig

public MasterAuthorizedNetworksConfig DesiredMasterAuthorizedNetworksConfig { get; set; }

The desired configuration options for master authorized networks feature.

Property Value
Type	Description
`MasterAuthorizedNetworksConfig`

DesiredMasterVersion

public string DesiredMasterVersion { get; set; }

The Kubernetes version to change the master to.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

"latest": picks the highest valid Kubernetes version
"1.X": picks the highest valid patch+gke.N patch in the 1.X version
"1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
"1.X.Y-gke.N": picks an explicit Kubernetes version
"-": picks the default Kubernetes version

Property Value
Type	Description
`String`

DesiredMeshCertificates

public MeshCertificates DesiredMeshCertificates { get; set; }

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Property Value
Type	Description
`MeshCertificates`

DesiredMonitoringConfig

public MonitoringConfig DesiredMonitoringConfig { get; set; }

The desired monitoring configuration.

Property Value
Type	Description
`MonitoringConfig`

DesiredMonitoringService

public string DesiredMonitoringService { get; set; }

The monitoring service the cluster should use to write metrics. Currently available options:

"monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
none - No metrics will be exported from the cluster.

If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

Property Value
Type	Description
`String`

DesiredNodePoolAutoConfigNetworkTags

public NetworkTags DesiredNodePoolAutoConfigNetworkTags { get; set; }

The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Property Value
Type	Description
`NetworkTags`

DesiredNodePoolAutoscaling

public NodePoolAutoscaling DesiredNodePoolAutoscaling { get; set; }

Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

Property Value
Type	Description
`NodePoolAutoscaling`

DesiredNodePoolId

public string DesiredNodePoolId { get; set; }

The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

Property Value
Type	Description
`String`

DesiredNodePoolLoggingConfig

public NodePoolLoggingConfig DesiredNodePoolLoggingConfig { get; set; }

The desired node pool logging configuration defaults for the cluster.

Property Value
Type	Description
`NodePoolLoggingConfig`

DesiredNodeVersion

public string DesiredNodeVersion { get; set; }

The Kubernetes version to change the nodes to (typically an upgrade).

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

"latest": picks the highest valid Kubernetes version
"1.X": picks the highest valid patch+gke.N patch in the 1.X version
"1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
"1.X.Y-gke.N": picks an explicit Kubernetes version
"-": picks the Kubernetes master version

Property Value
Type	Description
`String`

DesiredNotificationConfig

public NotificationConfig DesiredNotificationConfig { get; set; }

The desired notification configuration.

Property Value
Type	Description
`NotificationConfig`

DesiredPrivateClusterConfig

public PrivateClusterConfig DesiredPrivateClusterConfig { get; set; }

The desired private cluster configuration.

Property Value
Type	Description
`PrivateClusterConfig`

DesiredPrivateIpv6GoogleAccess

public PrivateIPv6GoogleAccess DesiredPrivateIpv6GoogleAccess { get; set; }

The desired state of IPv6 connectivity to Google Services.

Property Value
Type	Description
`PrivateIPv6GoogleAccess`

DesiredReleaseChannel

public ReleaseChannel DesiredReleaseChannel { get; set; }

The desired release channel configuration.

Property Value
Type	Description
`ReleaseChannel`

DesiredResourceUsageExportConfig

public ResourceUsageExportConfig DesiredResourceUsageExportConfig { get; set; }

The desired configuration for exporting resource usage.

Property Value
Type	Description
`ResourceUsageExportConfig`

DesiredServiceExternalIpsConfig

public ServiceExternalIPsConfig DesiredServiceExternalIpsConfig { get; set; }

ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.

Property Value
Type	Description
`ServiceExternalIPsConfig`

DesiredShieldedNodes

public ShieldedNodes DesiredShieldedNodes { get; set; }

Configuration for Shielded Nodes.

Property Value
Type	Description
`ShieldedNodes`

DesiredVerticalPodAutoscaling

public VerticalPodAutoscaling DesiredVerticalPodAutoscaling { get; set; }

Cluster-level Vertical Pod Autoscaling configuration.

Property Value
Type	Description
`VerticalPodAutoscaling`

DesiredWorkloadIdentityConfig

public WorkloadIdentityConfig DesiredWorkloadIdentityConfig { get; set; }

Configuration for Workload Identity.

Property Value
Type	Description
`WorkloadIdentityConfig`

HasDesiredEnablePrivateEndpoint

public bool HasDesiredEnablePrivateEndpoint { get; }

Gets whether the "desired_enable_private_endpoint" field is set

Property Value
Type	Description
`Boolean`