Reference documentation and code samples for the Distributed Cloud Edge Container V1 API class Google::Cloud::EdgeContainer::V1::Cluster.
A Google Distributed Cloud Edge Kubernetes cluster.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#authorization
def authorization() -> ::Google::Cloud::EdgeContainer::V1::Authorization
Returns
- (::Google::Cloud::EdgeContainer::V1::Authorization) — Required. Immutable. RBAC policy that will be applied and managed by GEC.
#authorization=
def authorization=(value) -> ::Google::Cloud::EdgeContainer::V1::Authorization
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Authorization) — Required. Immutable. RBAC policy that will be applied and managed by GEC.
Returns
- (::Google::Cloud::EdgeContainer::V1::Authorization) — Required. Immutable. RBAC policy that will be applied and managed by GEC.
#cluster_ca_certificate
def cluster_ca_certificate() -> ::String
Returns
- (::String) — Output only. The PEM-encoded public certificate of the cluster's CA.
#control_plane
def control_plane() -> ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane) — Optional. The configuration of the cluster control plane.
#control_plane=
def control_plane=(value) -> ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane) — Optional. The configuration of the cluster control plane.
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane) — Optional. The configuration of the cluster control plane.
#control_plane_encryption
def control_plane_encryption() -> ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption) — Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support.
#control_plane_encryption=
def control_plane_encryption=(value) -> ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption) — Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support.
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption) — Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support.
#control_plane_version
def control_plane_version() -> ::String
Returns
- (::String) — Output only. The control plane release version
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the cluster was created.
#default_max_pods_per_node
def default_max_pods_per_node() -> ::Integer
Returns
- (::Integer) — Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.
#default_max_pods_per_node=
def default_max_pods_per_node=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.
Returns
- (::Integer) — Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.
#endpoint
def endpoint() -> ::String
Returns
- (::String) — Output only. The IP address of the Kubernetes API server.
#external_load_balancer_ipv4_address_pools
def external_load_balancer_ipv4_address_pools() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. IPv4 address pools for cluster data plane external load balancing.
#external_load_balancer_ipv4_address_pools=
def external_load_balancer_ipv4_address_pools=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. IPv4 address pools for cluster data plane external load balancing.
Returns
- (::Array<::String>) — Optional. IPv4 address pools for cluster data plane external load balancing.
#external_load_balancer_ipv6_address_pools
def external_load_balancer_ipv6_address_pools() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. IPv6 address pools for cluster data plane external load balancing.
#external_load_balancer_ipv6_address_pools=
def external_load_balancer_ipv6_address_pools=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. IPv6 address pools for cluster data plane external load balancing.
Returns
- (::Array<::String>) — Optional. IPv6 address pools for cluster data plane external load balancing.
#fleet
def fleet() -> ::Google::Cloud::EdgeContainer::V1::Fleet
Returns
- (::Google::Cloud::EdgeContainer::V1::Fleet) — Required. Fleet configuration.
#fleet=
def fleet=(value) -> ::Google::Cloud::EdgeContainer::V1::Fleet
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Fleet) — Required. Fleet configuration.
Returns
- (::Google::Cloud::EdgeContainer::V1::Fleet) — Required. Fleet configuration.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this resource.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this resource.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this resource.
#maintenance_events
def maintenance_events() -> ::Array<::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent>
Returns
- (::Array<::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent>) — Output only. All the maintenance events scheduled for the cluster, including the ones ongoing, planned for the future and done in the past (up to 90 days).
#maintenance_policy
def maintenance_policy() -> ::Google::Cloud::EdgeContainer::V1::MaintenancePolicy
Returns
- (::Google::Cloud::EdgeContainer::V1::MaintenancePolicy) — Optional. Cluster-wide maintenance policy configuration.
#maintenance_policy=
def maintenance_policy=(value) -> ::Google::Cloud::EdgeContainer::V1::MaintenancePolicy
Parameter
- value (::Google::Cloud::EdgeContainer::V1::MaintenancePolicy) — Optional. Cluster-wide maintenance policy configuration.
Returns
- (::Google::Cloud::EdgeContainer::V1::MaintenancePolicy) — Optional. Cluster-wide maintenance policy configuration.
#name
def name() -> ::String
Returns
- (::String) — Required. The resource name of the cluster.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The resource name of the cluster.
Returns
- (::String) — Required. The resource name of the cluster.
#networking
def networking() -> ::Google::Cloud::EdgeContainer::V1::ClusterNetworking
Returns
- (::Google::Cloud::EdgeContainer::V1::ClusterNetworking) — Required. Cluster-wide networking configuration.
#networking=
def networking=(value) -> ::Google::Cloud::EdgeContainer::V1::ClusterNetworking
Parameter
- value (::Google::Cloud::EdgeContainer::V1::ClusterNetworking) — Required. Cluster-wide networking configuration.
Returns
- (::Google::Cloud::EdgeContainer::V1::ClusterNetworking) — Required. Cluster-wide networking configuration.
#node_version
def node_version() -> ::String
Returns
- (::String) — Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes.
#port
def port() -> ::Integer
Returns
- (::Integer) — Output only. The port number of the Kubernetes API server.
#release_channel
def release_channel() -> ::Google::Cloud::EdgeContainer::V1::Cluster::ReleaseChannel
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::ReleaseChannel) — Optional. The release channel a cluster is subscribed to.
#release_channel=
def release_channel=(value) -> ::Google::Cloud::EdgeContainer::V1::Cluster::ReleaseChannel
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Cluster::ReleaseChannel) — Optional. The release channel a cluster is subscribed to.
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::ReleaseChannel) — Optional. The release channel a cluster is subscribed to.
#status
def status() -> ::Google::Cloud::EdgeContainer::V1::Cluster::Status
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::Status) — Output only. The current status of the cluster.
#survivability_config
def survivability_config() -> ::Google::Cloud::EdgeContainer::V1::Cluster::SurvivabilityConfig
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::SurvivabilityConfig) — Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters.
#survivability_config=
def survivability_config=(value) -> ::Google::Cloud::EdgeContainer::V1::Cluster::SurvivabilityConfig
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Cluster::SurvivabilityConfig) — Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters.
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::SurvivabilityConfig) — Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters.
#system_addons_config
def system_addons_config() -> ::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig) — Optional. The configuration of the system add-ons.
#system_addons_config=
def system_addons_config=(value) -> ::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig
Parameter
- value (::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig) — Optional. The configuration of the system add-ons.
Returns
- (::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig) — Optional. The configuration of the system add-ons.
#target_version
def target_version() -> ::String
Returns
- (::String) — Optional. The target cluster version. For example: "1.5.0".
#target_version=
def target_version=(value) -> ::String
Parameter
- value (::String) — Optional. The target cluster version. For example: "1.5.0".
Returns
- (::String) — Optional. The target cluster version. For example: "1.5.0".
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the cluster was last updated.