Google Cloud Gke Hub V1 Client - Class GenerateConnectManifestRequest (1.0.0)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class GenerateConnectManifestRequest.

Request message for GkeHub.GenerateConnectManifest method.

.

Generated from protobuf message google.cloud.gkehub.v1.GenerateConnectManifestRequest

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*.

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

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

↳ version string

Optional. The Connect agent version to use. Defaults to the most current version.

↳ is_upgrade bool

Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.

↳ registry string

Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.

↳ image_pull_secret_content string

Optional. The image pull secret content for the registry, if not public.

getName

Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*.

Returns
Type Description
string

setName

Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*.

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

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

getVersion

Optional. The Connect agent version to use. Defaults to the most current version.

Returns
Type Description
string

setVersion

Optional. The Connect agent version to use. Defaults to the most current version.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsUpgrade

Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.

Returns
Type Description
bool

setIsUpgrade

Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRegistry

Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.

Returns
Type Description
string

setRegistry

Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.

Parameter
Name Description
var string
Returns
Type Description
$this

getImagePullSecretContent

Optional. The image pull secret content for the registry, if not public.

Returns
Type Description
string

setImagePullSecretContent

Optional. The image pull secret content for the registry, if not public.

Parameter
Name Description
var string
Returns
Type Description
$this