Reference documentation and code samples for the Connect Gateway V1beta1 API class Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest.
A request for connection information for a particular membership.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#force_use_agent
defforce_use_agent()->::Boolean
Returns
(::Boolean) — 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.
#force_use_agent=
defforce_use_agent=(value)->::Boolean
Parameter
value (::Boolean) — 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
(::Boolean) — 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.
#kubernetes_namespace
defkubernetes_namespace()->::String
Returns
(::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.
#kubernetes_namespace=
defkubernetes_namespace=(value)->::String
Parameter
value (::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.
Returns
(::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.
#name
defname()->::String
Returns
(::String) — Required. The Fleet membership resource.
#name=
defname=(value)->::String
Parameter
value (::String) — Required. The Fleet membership resource.
Returns
(::String) — Required. The Fleet membership resource.
[[["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-09 UTC."],[],[],null,["# Connect Gateway V1beta1 API - Class Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest (v0.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.10.0 (latest)](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/latest/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.9.1](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.9.1/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.8.0/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.7.1/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.6.0/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.5.2](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.5.2/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.4.0/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.3.0/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.2.0/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest)\n- [0.1.5](/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/0.1.5/Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest) \nReference documentation and code samples for the Connect Gateway V1beta1 API class Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest.\n\nA request for connection information for a particular membership. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #force_use_agent\n\n def force_use_agent() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. Whether to force the use of Connect Agent-based transport.\n\n This will return a configuration that uses Connect Agent as the underlying\n transport mechanism for cluster types that would otherwise have used a\n different transport. Requires that Connect Agent be installed on the\n cluster. Setting this field to false is equivalent to not setting it.\n\n### #force_use_agent=\n\n def force_use_agent=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. Whether to force the use of Connect Agent-based transport.\n\n\n This will return a configuration that uses Connect Agent as the underlying\n transport mechanism for cluster types that would otherwise have used a\n different transport. Requires that Connect Agent be installed on the\ncluster. Setting this field to false is equivalent to not setting it. \n**Returns**\n\n- (::Boolean) --- Optional. Whether to force the use of Connect Agent-based transport.\n\n This will return a configuration that uses Connect Agent as the underlying\n transport mechanism for cluster types that would otherwise have used a\n different transport. Requires that Connect Agent be installed on the\n cluster. Setting this field to false is equivalent to not setting it.\n\n### #kubernetes_namespace\n\n def kubernetes_namespace() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The namespace to use in the kubeconfig context.\n\n If this field is specified, the server will set the `namespace` field in\n kubeconfig context. If not specified, the `namespace` field is omitted.\n\n### #kubernetes_namespace=\n\n def kubernetes_namespace=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The namespace to use in the kubeconfig context.\n\n\n If this field is specified, the server will set the `namespace` field in\nkubeconfig context. If not specified, the `namespace` field is omitted. \n**Returns**\n\n- (::String) --- Optional. The namespace to use in the kubeconfig context.\n\n If this field is specified, the server will set the `namespace` field in\n kubeconfig context. If not specified, the `namespace` field is omitted.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The Fleet membership resource.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The Fleet membership resource. \n**Returns**\n\n- (::String) --- Required. The Fleet membership resource.\n\n### #operating_system\n\n def operating_system() -\u003e ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem\n\n**Returns**\n\n- ([::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem](./Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest-OperatingSystem)) --- Optional. The operating system where the kubeconfig will be used.\n\n### #operating_system=\n\n def operating_system=(value) -\u003e ::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem\n\n**Parameter**\n\n- **value** ([::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem](./Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest-OperatingSystem)) --- Optional. The operating system where the kubeconfig will be used. \n**Returns**\n\n- ([::Google::Cloud::GkeConnect::Gateway::V1beta1::GenerateCredentialsRequest::OperatingSystem](./Google-Cloud-GkeConnect-Gateway-V1beta1-GenerateCredentialsRequest-OperatingSystem)) --- Optional. The operating system where the kubeconfig will be used.\n\n### #version\n\n def version() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The Connect Gateway version to be used in the resulting configuration.\n\n Leave this field blank to let the server choose the version (recommended).\n\n### #version=\n\n def version=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The Connect Gateway version to be used in the resulting configuration.\n\n\nLeave this field blank to let the server choose the version (recommended). \n**Returns**\n\n- (::String) --- Optional. The Connect Gateway version to be used in the resulting configuration.\n\n Leave this field blank to let the server choose the version (recommended)."]]
