Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::ControlPlaneEndpointsConfig::DNSEndpointConfig.
Describes the configuration of a DNS endpoint.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#allow_external_traffic
defallow_external_traffic()->::Boolean
Returns
(::Boolean) — Controls whether user traffic is allowed over this endpoint. Note that
GCP-managed services may still use the endpoint even if this is false.
#allow_external_traffic=
defallow_external_traffic=(value)->::Boolean
Parameter
value (::Boolean) — Controls whether user traffic is allowed over this endpoint. Note that
GCP-managed services may still use the endpoint even if this is false.
Returns
(::Boolean) — Controls whether user traffic is allowed over this endpoint. Note that
GCP-managed services may still use the endpoint even if this is false.
#endpoint
defendpoint()->::String
Returns
(::String) — Output only. The cluster's DNS endpoint configuration.
A DNS format address. This is accessible from the public internet.
Ex: uid.us-central1.gke.goog.
Always present, but the behavior may change according to the value of
DNSEndpointConfig.allow_external_traffic.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::ControlPlaneEndpointsConfig::DNSEndpointConfig (v1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/ruby/docs/reference/google-cloud-container-v1/latest/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.8.0](/ruby/docs/reference/google-cloud-container-v1/1.8.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.7.0](/ruby/docs/reference/google-cloud-container-v1/1.7.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.6.1](/ruby/docs/reference/google-cloud-container-v1/1.6.1/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.5.0](/ruby/docs/reference/google-cloud-container-v1/1.5.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.4.0](/ruby/docs/reference/google-cloud-container-v1/1.4.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.3.0](/ruby/docs/reference/google-cloud-container-v1/1.3.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-container-v1/1.2.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.1.1](/ruby/docs/reference/google-cloud-container-v1/1.1.1/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [1.0.0](/ruby/docs/reference/google-cloud-container-v1/1.0.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.42.0](/ruby/docs/reference/google-cloud-container-v1/0.42.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.41.0](/ruby/docs/reference/google-cloud-container-v1/0.41.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.40.0](/ruby/docs/reference/google-cloud-container-v1/0.40.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.39.0](/ruby/docs/reference/google-cloud-container-v1/0.39.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.38.0](/ruby/docs/reference/google-cloud-container-v1/0.38.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.37.0](/ruby/docs/reference/google-cloud-container-v1/0.37.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.36.0](/ruby/docs/reference/google-cloud-container-v1/0.36.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.35.0](/ruby/docs/reference/google-cloud-container-v1/0.35.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.34.1](/ruby/docs/reference/google-cloud-container-v1/0.34.1/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.33.1](/ruby/docs/reference/google-cloud-container-v1/0.33.1/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.32.0](/ruby/docs/reference/google-cloud-container-v1/0.32.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.31.0](/ruby/docs/reference/google-cloud-container-v1/0.31.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.30.0](/ruby/docs/reference/google-cloud-container-v1/0.30.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.29.0](/ruby/docs/reference/google-cloud-container-v1/0.29.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.28.0](/ruby/docs/reference/google-cloud-container-v1/0.28.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.27.0](/ruby/docs/reference/google-cloud-container-v1/0.27.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.26.0](/ruby/docs/reference/google-cloud-container-v1/0.26.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.25.0](/ruby/docs/reference/google-cloud-container-v1/0.25.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.24.0](/ruby/docs/reference/google-cloud-container-v1/0.24.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.23.0](/ruby/docs/reference/google-cloud-container-v1/0.23.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.22.0](/ruby/docs/reference/google-cloud-container-v1/0.22.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.21.1](/ruby/docs/reference/google-cloud-container-v1/0.21.1/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.20.0](/ruby/docs/reference/google-cloud-container-v1/0.20.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.19.0](/ruby/docs/reference/google-cloud-container-v1/0.19.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.18.0](/ruby/docs/reference/google-cloud-container-v1/0.18.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.17.0](/ruby/docs/reference/google-cloud-container-v1/0.17.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.16.3](/ruby/docs/reference/google-cloud-container-v1/0.16.3/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.15.0](/ruby/docs/reference/google-cloud-container-v1/0.15.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.14.0](/ruby/docs/reference/google-cloud-container-v1/0.14.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-container-v1/0.13.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-container-v1/0.12.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.11.0](/ruby/docs/reference/google-cloud-container-v1/0.11.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.10.0](/ruby/docs/reference/google-cloud-container-v1/0.10.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.9.1](/ruby/docs/reference/google-cloud-container-v1/0.9.1/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.8.0](/ruby/docs/reference/google-cloud-container-v1/0.8.0/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig)\n- [0.7.3](/ruby/docs/reference/google-cloud-container-v1/0.7.3/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig) \nReference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::ControlPlaneEndpointsConfig::DNSEndpointConfig.\n\nDescribes the configuration of a DNS endpoint. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #allow_external_traffic\n\n def allow_external_traffic() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.\n\n### #allow_external_traffic=\n\n def allow_external_traffic=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. \n**Returns**\n\n- (::Boolean) --- Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.\n\n### #endpoint\n\n def endpoint() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of [DNSEndpointConfig.allow_external_traffic](/ruby/docs/reference/google-cloud-container-v1/latest/Google-Cloud-Container-V1-ControlPlaneEndpointsConfig-DNSEndpointConfig#Google__Cloud__Container__V1__ControlPlaneEndpointsConfig__DNSEndpointConfig_allow_external_traffic_instance_ \"Google::Cloud::Container::V1::ControlPlaneEndpointsConfig::DNSEndpointConfig#allow_external_traffic (method)\")."]]