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

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

Namespace

Google \ Cloud \ GkeHub \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
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
Type Description
string

setName

Do not set.

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this