Reference documentation and code samples for the Google Cloud Gke Connect Gateway V1 Client class GenerateCredentialsRequest.
A request for connection information for a particular membership.
Generated from protobuf message google.cloud.gkeconnect.gateway.v1.GenerateCredentialsRequest
Namespace
Google \ Cloud \ GkeConnect \ Gateway \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The Fleet membership resource. |
↳ force_use_agent |
bool
Optional. Whether to force the use of Connect Agent-based transport. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it. |
↳ version |
string
Optional. The Connect Gateway version to be used in the resulting configuration. Leave this field blank to let the server choose the version (recommended). |
↳ kubernetes_namespace |
string
Optional. The namespace to use in the kubeconfig context. If this field is specified, the server will set the |
↳ operating_system |
int
Optional. The operating system where the kubeconfig will be used. |
getName
Required. The Fleet membership resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The Fleet membership resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForceUseAgent
Optional. Whether to force the use of Connect Agent-based transport.
This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForceUseAgent
Optional. Whether to force the use of Connect Agent-based transport.
This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersion
Optional. The Connect Gateway version to be used in the resulting configuration.
Leave this field blank to let the server choose the version (recommended).
| Returns | |
|---|---|
| Type | Description |
string |
|
setVersion
Optional. The Connect Gateway version to be used in the resulting configuration.
Leave this field blank to let the server choose the version (recommended).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKubernetesNamespace
Optional. The namespace to use in the kubeconfig context.
If this field is specified, the server will set the namespace field in
kubeconfig context. If not specified, the namespace field is omitted.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKubernetesNamespace
Optional. The namespace to use in the kubeconfig context.
If this field is specified, the server will set the namespace field in
kubeconfig context. If not specified, the namespace field is omitted.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOperatingSystem
Optional. The operating system where the kubeconfig will be used.
| Returns | |
|---|---|
| Type | Description |
int |
|
setOperatingSystem
Optional. The operating system where the kubeconfig will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|