Google Cloud Gke Hub V1beta1 Client - Class ConnectAgent (0.5.6)

Reference documentation and code samples for the Google Cloud Gke Hub V1beta1 Client class ConnectAgent.

The information required from end users to use GKE Connect.

Generated from protobuf message google.cloud.gkehub.v1beta1.ConnectAgent

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Do not set.

↳ proxy 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.

↳ namespace 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.

getName

Do not set.

Returns
TypeDescription
string

setName

Do not set.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProxy

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
TypeDescription
string

setProxy

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNamespace

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
TypeDescription
string

setNamespace

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this