Reference documentation and code samples for the GKE Hub V1beta1 API class Google::Cloud::GkeHub::V1beta1::ConnectAgent.
The information required from end users to use GKE Connect.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#name
defname()->::String
Returns
(::String) — Do not set.
#name=
defname=(value)->::String
Parameter
value (::String) — Do not set.
Returns
(::String) — Do not set.
#namespace
defnamespace()->::String
Returns
(::String) — Optional. Namespace for GKE Connect agent resources. Defaults to
gke-connect.
The Connect Agent is authorized automatically when run in the default
namespace. Otherwise, explicit authorization must be granted with an
additional IAM binding.
#namespace=
defnamespace=(value)->::String
Parameter
value (::String) — Optional. Namespace for GKE Connect agent resources. Defaults to
gke-connect.
The Connect Agent is authorized automatically when run in the default
namespace. Otherwise, explicit authorization must be granted with an
additional IAM binding.
Returns
(::String) — Optional. Namespace for GKE Connect agent resources. Defaults to
gke-connect.
The Connect Agent is authorized automatically when run in the default
namespace. Otherwise, explicit authorization must be granted with an
additional IAM binding.
#proxy
defproxy()->::String
Returns
(::String) — Optional. URI of a proxy if connectivity from the agent to
gkeconnect.googleapis.com requires the use of a proxy. Format must be in
the form http(s)://{proxy_address}, depending on the HTTP/HTTPS protocol
supported by the proxy. This will direct the connect agent's outbound
traffic through a HTTP(S) proxy.
#proxy=
defproxy=(value)->::String
Parameter
value (::String) — Optional. URI of a proxy if connectivity from the agent to
gkeconnect.googleapis.com requires the use of a proxy. Format must be in
the form http(s)://{proxy_address}, depending on the HTTP/HTTPS protocol
supported by the proxy. This will direct the connect agent's outbound
traffic through a HTTP(S) proxy.
Returns
(::String) — Optional. URI of a proxy if connectivity from the agent to
gkeconnect.googleapis.com requires the use of a proxy. Format must be in
the form http(s)://{proxy_address}, depending on the HTTP/HTTPS protocol
supported by the proxy. This will direct the connect agent's outbound
traffic through a HTTP(S) proxy.
[[["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-08-28 UTC."],[],[],null,["# GKE Hub V1beta1 API - Class Google::Cloud::GkeHub::V1beta1::ConnectAgent (v0.15.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.15.0 (latest)](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/latest/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.14.1](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.14.1/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.13.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.13.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.12.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.12.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.11.1](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.11.1/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.10.2](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.10.2/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.9.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.9.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.8.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.8.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.7.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.7.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.6.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.6.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.5.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.5.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.4.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.4.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.3.0](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.3.0/Google-Cloud-GkeHub-V1beta1-ConnectAgent)\n- [0.2.2](/ruby/docs/reference/google-cloud-gke_hub-v1beta1/0.2.2/Google-Cloud-GkeHub-V1beta1-ConnectAgent) \nReference documentation and code samples for the GKE Hub V1beta1 API class Google::Cloud::GkeHub::V1beta1::ConnectAgent.\n\nThe information required from end users to use GKE Connect. \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### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Do not set.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Do not set. \n**Returns**\n\n- (::String) --- Do not set.\n\n### #namespace\n\n def namespace() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.\n\n\n The Connect Agent is authorized automatically when run in the default\n namespace. Otherwise, explicit authorization must be granted with an\n additional IAM binding.\n\n### #namespace=\n\n def namespace=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.\n\n\n The Connect Agent is authorized automatically when run in the default\n namespace. Otherwise, explicit authorization must be granted with an\nadditional IAM binding. \n**Returns**\n\n- (::String) --- Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.\n\n\n The Connect Agent is authorized automatically when run in the default\n namespace. Otherwise, explicit authorization must be granted with an\n additional IAM binding.\n\n### #proxy\n\n def proxy() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy.\n\n### #proxy=\n\n def proxy=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy. \n**Returns**\n\n- (::String) --- Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy."]]
