Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::UpdateNodePoolRequest (v0.38.0)

Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::UpdateNodePoolRequest.

UpdateNodePoolRequests update a node pool's image and/or version.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cluster_id

def cluster_id() -> ::String
Returns
  • (::String) — Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

#cluster_id=

def cluster_id=(value) -> ::String
Parameter
  • value (::String) — Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
Returns
  • (::String) — Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

#confidential_nodes

def confidential_nodes() -> ::Google::Cloud::Container::V1::ConfidentialNodes
Returns

#confidential_nodes=

def confidential_nodes=(value) -> ::Google::Cloud::Container::V1::ConfidentialNodes
Parameter
Returns

#disk_size_gb

def disk_size_gb() -> ::Integer
Returns
  • (::Integer) — Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.
Returns
  • (::Integer) — Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.

#disk_type

def disk_type() -> ::String
Returns
  • (::String) — Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.

#disk_type=

def disk_type=(value) -> ::String
Parameter
  • value (::String) — Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.
Returns
  • (::String) — Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.

#etag

def etag() -> ::String
Returns
  • (::String) — The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.
Returns
  • (::String) — The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.

#fast_socket

def fast_socket() -> ::Google::Cloud::Container::V1::FastSocket
Returns

#fast_socket=

def fast_socket=(value) -> ::Google::Cloud::Container::V1::FastSocket
Parameter
Returns

#gcfs_config

def gcfs_config() -> ::Google::Cloud::Container::V1::GcfsConfig
Returns

#gcfs_config=

def gcfs_config=(value) -> ::Google::Cloud::Container::V1::GcfsConfig
Parameter
Returns

#gvnic

def gvnic() -> ::Google::Cloud::Container::V1::VirtualNIC
Returns

#gvnic=

def gvnic=(value) -> ::Google::Cloud::Container::V1::VirtualNIC
Parameter
Returns

#image_type

def image_type() -> ::String
Returns
  • (::String) — Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

#image_type=

def image_type=(value) -> ::String
Parameter
  • value (::String) — Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
Returns
  • (::String) — Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

#kubelet_config

def kubelet_config() -> ::Google::Cloud::Container::V1::NodeKubeletConfig
Returns

#kubelet_config=

def kubelet_config=(value) -> ::Google::Cloud::Container::V1::NodeKubeletConfig
Parameter
Returns

#labels

def labels() -> ::Google::Cloud::Container::V1::NodeLabels
Returns
  • (::Google::Cloud::Container::V1::NodeLabels) — The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.

#labels=

def labels=(value) -> ::Google::Cloud::Container::V1::NodeLabels
Parameter
  • value (::Google::Cloud::Container::V1::NodeLabels) — The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.
Returns
  • (::Google::Cloud::Container::V1::NodeLabels) — The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.

#linux_node_config

def linux_node_config() -> ::Google::Cloud::Container::V1::LinuxNodeConfig
Returns

#linux_node_config=

def linux_node_config=(value) -> ::Google::Cloud::Container::V1::LinuxNodeConfig
Parameter
Returns

#locations

def locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.

#locations=

def locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
Returns
  • (::Array<::String>) — The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.

#logging_config

def logging_config() -> ::Google::Cloud::Container::V1::NodePoolLoggingConfig
Returns

#logging_config=

def logging_config=(value) -> ::Google::Cloud::Container::V1::NodePoolLoggingConfig
Parameter
Returns

#machine_type

def machine_type() -> ::String
Returns
  • (::String) — Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.

#machine_type=

def machine_type=(value) -> ::String
Parameter
  • value (::String) — Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.
Returns
  • (::String) — Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.

#name

def name() -> ::String
Returns
  • (::String) — The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.
Returns
  • (::String) — The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

#node_network_config

def node_network_config() -> ::Google::Cloud::Container::V1::NodeNetworkConfig
Returns

#node_network_config=

def node_network_config=(value) -> ::Google::Cloud::Container::V1::NodeNetworkConfig
Parameter
Returns

#node_pool_id

def node_pool_id() -> ::String
Returns
  • (::String) — Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

#node_pool_id=

def node_pool_id=(value) -> ::String
Parameter
  • value (::String) — Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
Returns
  • (::String) — Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

#node_version

def node_version() -> ::String
Returns
  • (::String) —

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

#node_version=

def node_version=(value) -> ::String
Parameter
  • value (::String) —

    Required. 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
Returns
  • (::String) —

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

#project_id

def project_id() -> ::String
Returns
  • (::String) — Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
Returns
  • (::String) — Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

#queued_provisioning

def queued_provisioning() -> ::Google::Cloud::Container::V1::NodePool::QueuedProvisioning
Returns

#queued_provisioning=

def queued_provisioning=(value) -> ::Google::Cloud::Container::V1::NodePool::QueuedProvisioning
Parameter
Returns

#resource_labels

def resource_labels() -> ::Google::Cloud::Container::V1::ResourceLabels
Returns

#resource_labels=

def resource_labels=(value) -> ::Google::Cloud::Container::V1::ResourceLabels
Parameter
Returns

#resource_manager_tags

def resource_manager_tags() -> ::Google::Cloud::Container::V1::ResourceManagerTags
Returns

#resource_manager_tags=

def resource_manager_tags=(value) -> ::Google::Cloud::Container::V1::ResourceManagerTags
Parameter
  • value (::Google::Cloud::Container::V1::ResourceManagerTags) — Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
Returns

#tags

def tags() -> ::Google::Cloud::Container::V1::NetworkTags
Returns
  • (::Google::Cloud::Container::V1::NetworkTags) — The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.

#tags=

def tags=(value) -> ::Google::Cloud::Container::V1::NetworkTags
Parameter
  • value (::Google::Cloud::Container::V1::NetworkTags) — The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.
Returns
  • (::Google::Cloud::Container::V1::NetworkTags) — The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.

#taints

def taints() -> ::Google::Cloud::Container::V1::NodeTaints
Returns
  • (::Google::Cloud::Container::V1::NodeTaints) — The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.

#taints=

def taints=(value) -> ::Google::Cloud::Container::V1::NodeTaints
Parameter
  • value (::Google::Cloud::Container::V1::NodeTaints) — The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.
Returns
  • (::Google::Cloud::Container::V1::NodeTaints) — The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.

#upgrade_settings

def upgrade_settings() -> ::Google::Cloud::Container::V1::NodePool::UpgradeSettings
Returns

#upgrade_settings=

def upgrade_settings=(value) -> ::Google::Cloud::Container::V1::NodePool::UpgradeSettings
Parameter
Returns

#windows_node_config

def windows_node_config() -> ::Google::Cloud::Container::V1::WindowsNodeConfig
Returns

#windows_node_config=

def windows_node_config=(value) -> ::Google::Cloud::Container::V1::WindowsNodeConfig
Parameter
Returns

#workload_metadata_config

def workload_metadata_config() -> ::Google::Cloud::Container::V1::WorkloadMetadataConfig
Returns

#workload_metadata_config=

def workload_metadata_config=(value) -> ::Google::Cloud::Container::V1::WorkloadMetadataConfig
Parameter
Returns

#zone

def zone() -> ::String
Returns
  • (::String) — Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

#zone=

def zone=(value) -> ::String
Parameter
  • value (::String) — Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
Returns
  • (::String) — Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.