gateway

Documentation

Overview

Package gateway is an auto-generated package for the Connect Gateway API.

The Connect Gateway service allows connectivity from external parties to connected Kubernetes clusters.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := gateway.NewGatewayControlClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := gateway.NewGatewayControlClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

req := &gatewaypb.GenerateCredentialsRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/gkeconnect/gateway/apiv1/gatewaypb#GenerateCredentialsRequest.
}
resp, err := c.GenerateCredentials(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewGatewayControlClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Index

• func DefaultAuthScopes() []string
• type GatewayControlCallOptions
• type GatewayControlClient
  • func NewGatewayControlClient(ctx context.Context, opts ...option.ClientOption) (*GatewayControlClient, error)
  • func NewGatewayControlRESTClient(ctx context.Context, opts ...option.ClientOption) (*GatewayControlClient, error)
  • func (c *GatewayControlClient) Close() error
  • func (c *GatewayControlClient) Connection() *grpc.ClientConn
  • func (c *GatewayControlClient) GenerateCredentials(ctx context.Context, req *gatewaypb.GenerateCredentialsRequest, ...) (*gatewaypb.GenerateCredentialsResponse, error)

Examples

• GatewayControlClient.GenerateCredentials
• NewGatewayControlClient
• NewGatewayControlRESTClient

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type GatewayControlCallOptions

type GatewayControlCallOptions struct {
	GenerateCredentials []gax.CallOption
}

GatewayControlCallOptions contains the retry settings for each method of GatewayControlClient.

type GatewayControlClient

type GatewayControlClient struct {

	// The call options for this service.
	CallOptions *GatewayControlCallOptions
	// contains filtered or unexported fields
}

GatewayControlClient is a client for interacting with Connect Gateway API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

GatewayControl is the control plane API for Connect Gateway.

func NewGatewayControlClient

func NewGatewayControlClient(ctx context.Context, opts ...option.ClientOption) (*GatewayControlClient, error)

NewGatewayControlClient creates a new gateway control client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

GatewayControl is the control plane API for Connect Gateway.

Example

package main

import (
	"context"

	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := gateway.NewGatewayControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewGatewayControlRESTClient

func NewGatewayControlRESTClient(ctx context.Context, opts ...option.ClientOption) (*GatewayControlClient, error)

NewGatewayControlRESTClient creates a new gateway control rest client.

GatewayControl is the control plane API for Connect Gateway.

Example

package main

import (
	"context"

	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := gateway.NewGatewayControlRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*GatewayControlClient) Close

func (c *GatewayControlClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*GatewayControlClient) Connection

func (c *GatewayControlClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*GatewayControlClient) GenerateCredentials

func (c *GatewayControlClient) GenerateCredentials(ctx context.Context, req *gatewaypb.GenerateCredentialsRequest, opts ...gax.CallOption) (*gatewaypb.GenerateCredentialsResponse, error)

GenerateCredentials generateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Example

package main

import (
	"context"

	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1"
	gatewaypb "cloud.google.com/go/gkeconnect/gateway/apiv1/gatewaypb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := gateway.NewGatewayControlClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gatewaypb.GenerateCredentialsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/gkeconnect/gateway/apiv1/gatewaypb#GenerateCredentialsRequest.
	}
	resp, err := c.GenerateCredentials(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}