As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Gkeconnect Gateway v1beta1 API

class google.cloud.gkeconnect.gateway_v1beta1.types.GenerateCredentialsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request for connection information for a particular membership.

name

Required. The Fleet membership resource.

Type

str

force_use_agent

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.

Type

bool

version

Optional. The Connect Gateway version to be used in the resulting configuration.

Leave this field blank to let the server choose the version (recommended).

Type

str

kubernetes_namespace

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.

Type

str

operating_system

Optional. The operating system where the kubeconfig will be used.

Type

google.cloud.gkeconnect.gateway_v1beta1.types.GenerateCredentialsRequest.OperatingSystem

class OperatingSystem(value)

Bases: proto.enums.Enum

Operating systems requiring specialized kubeconfigs.

Values:

OPERATING_SYSTEM_UNSPECIFIED (0):

Generates a kubeconfig that works for all operating systems not defined below.

OPERATING_SYSTEM_WINDOWS (1):

Generates a kubeconfig that is specifically designed to work with Windows.

class google.cloud.gkeconnect.gateway_v1beta1.types.GenerateCredentialsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Connection information for a particular membership.

kubeconfig

A full YAML kubeconfig in serialized format.

Type

bytes

endpoint

The generated URI of the cluster as accessed through the Connect Gateway API.

Type

str