Reference documentation and code samples for the Google Cloud Gke Connect Gateway V1beta1 Client class GenerateCredentialsRequest.
A request for connection information for a particular membership.
Generated from protobuf message google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest
Namespace
Google \ Cloud \ GkeConnect \ Gateway \ V1beta1
Methods
__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 namespace field in kubeconfig context. If not specified, the namespace field is omitted.
↳ 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.
[[["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-09-04 UTC."],[],[],null,["# Google Cloud Gke Connect Gateway V1beta1 Client - Class GenerateCredentialsRequest (1.0.2)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.2 (latest)](/php/docs/reference/cloud-gke-connect-gateway/latest/V1beta1.GenerateCredentialsRequest)\n- [1.0.1](/php/docs/reference/cloud-gke-connect-gateway/1.0.1/V1beta1.GenerateCredentialsRequest)\n- [0.6.1](/php/docs/reference/cloud-gke-connect-gateway/0.6.1/V1beta1.GenerateCredentialsRequest)\n- [0.5.1](/php/docs/reference/cloud-gke-connect-gateway/0.5.1/V1beta1.GenerateCredentialsRequest)\n- [0.4.4](/php/docs/reference/cloud-gke-connect-gateway/0.4.4/V1beta1.GenerateCredentialsRequest)\n- [0.3.1](/php/docs/reference/cloud-gke-connect-gateway/0.3.1/V1beta1.GenerateCredentialsRequest)\n- [0.2.1](/php/docs/reference/cloud-gke-connect-gateway/0.2.1/V1beta1.GenerateCredentialsRequest)\n- [0.1.12](/php/docs/reference/cloud-gke-connect-gateway/0.1.12/V1beta1.GenerateCredentialsRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Gke Connect Gateway V1beta1 Client class GenerateCredentialsRequest.\n\nA request for connection information for a particular membership.\n\nGenerated from protobuf message `google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeConnect \\\\ Gateway \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The Fleet membership resource.\n\n### setName\n\nRequired. The Fleet membership resource.\n\n### getForceUseAgent\n\nOptional. Whether to force the use of Connect Agent-based transport.\n\nThis will return a configuration that uses Connect Agent as the underlying\ntransport mechanism for cluster types that would otherwise have used a\ndifferent transport. Requires that Connect Agent be installed on the\ncluster. Setting this field to false is equivalent to not setting it.\n\n### setForceUseAgent\n\nOptional. Whether to force the use of Connect Agent-based transport.\n\nThis will return a configuration that uses Connect Agent as the underlying\ntransport mechanism for cluster types that would otherwise have used a\ndifferent transport. Requires that Connect Agent be installed on the\ncluster. Setting this field to false is equivalent to not setting it.\n\n### getVersion\n\nOptional. The Connect Gateway version to be used in the resulting\nconfiguration.\n\nLeave this field blank to let the server choose the version (recommended).\n\n### setVersion\n\nOptional. The Connect Gateway version to be used in the resulting\nconfiguration.\n\nLeave this field blank to let the server choose the version (recommended).\n\n### getKubernetesNamespace\n\nOptional. The namespace to use in the kubeconfig context.\n\nIf this field is specified, the server will set the `namespace` field in\nkubeconfig context. If not specified, the `namespace` field is omitted.\n\n### setKubernetesNamespace\n\nOptional. The namespace to use in the kubeconfig context.\n\nIf this field is specified, the server will set the `namespace` field in\nkubeconfig context. If not specified, the `namespace` field is omitted.\n\n### getOperatingSystem\n\nOptional. The operating system where the kubeconfig will be used.\n\n### setOperatingSystem\n\nOptional. The operating system where the kubeconfig will be used."]]
