File: //snap/google-cloud-cli/394/lib/googlecloudsdk/api_lib/container/fleet/connectgateway/client.py
# -*- coding: utf-8 -*- #
# Copyright 2024 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Connect Gateway API client.
This does not provide client methods for GatewayService, which expects raw HTTP
requests as provided by e.g. kubectl.
"""
from typing import Union
from googlecloudsdk.api_lib.container.fleet.connectgateway import util
from googlecloudsdk.calliope import base
class GatewayClient:
"""Client for the Connect Gateway API with related helper methods.
If not provided, the default client is for the GA (v1) track. This client
is a thin wrapper around the base client, and does not handle any exceptions.
Fields:
release_track: The release track of the command [ALPHA, BETA, GA].
client: The raw GKE Hub API client for the specified release track.
messages: The matching messages module for the client.
"""
def __init__(self, release_track: base.ReleaseTrack = util.DEFAULT_TRACK):
self.release_track = (
release_track if release_track is not None else util.DEFAULT_TRACK
)
self.client = util.GetClientInstance(release_track)
self.messages = util.GetMessagesModule(release_track)
def GenerateCredentials(
self,
name: str,
force_use_agent: bool = False,
version: Union[str, None] = None,
kubernetes_namespace: Union[str, None] = None,
operating_system: util.TYPES.OperatingSystem = None,
) -> util.TYPES.GenerateCredentialsResponse:
"""Retrieve connection information for accessing a membership through Connect Gateway.
Args:
name: The full membership name, in the form
`projects/*/locations/*/memberships/*`.
force_use_agent: Whether to force the use of Connect Agent-based
transport.
version: The Connect Gateway version to be used in the resulting
configuration.
kubernetes_namespace: The namespace to use in the kubeconfig context.
operating_system: The operating system for which the kubeconfig should be
generated. The default value of `None` works for supported operating
systems other than Windows.
Returns:
The GenerateCredentialsResponse message.
"""
req = self.messages.ConnectgatewayProjectsLocationsMembershipsGenerateCredentialsRequest(
name=name,
forceUseAgent=force_use_agent,
version=version,
kubernetesNamespace=kubernetes_namespace,
operatingSystem=operating_system,
)
return self.client.projects_locations_memberships.GenerateCredentials(req)