Package cloud.google.com/go/gkeconnect/gateway/apiv1beta1

Stay organized with collections Save and categorize content based on your preferences.

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.

Use of Context

The ctx passed to NewClient 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.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

CallOptions

type CallOptions struct {
	GetResource    []gax.CallOption
	PostResource   []gax.CallOption
	DeleteResource []gax.CallOption
	PutResource    []gax.CallOption
	PatchResource  []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

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

Client 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.

Gateway service is a public API which works as a Kubernetes resource model proxy between end users and registered Kubernetes clusters. Each RPC in this service matches with an HTTP verb. End user will initiate kubectl commands against the Gateway service, and Gateway service will forward user requests to clusters.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

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

Gateway service is a public API which works as a Kubernetes resource model proxy between end users and registered Kubernetes clusters. Each RPC in this service matches with an HTTP verb. End user will initiate kubectl commands against the Gateway service, and Gateway service will forward user requests to clusters.

Example

package main

import (
	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1beta1"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := gateway.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) Close

func (c *Client) Close() error

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

func (*Client) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*Client) DeleteResource

func (c *Client) DeleteResource(ctx context.Context, req *httpbodypb.HttpBody, opts ...gax.CallOption) (*httpbodypb.HttpBody, error)

DeleteResource deleteResource performs an HTTP DELETE on the Kubernetes API Server.

Example

package main

import (
	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1beta1"
	"context"
	httpbodypb "google.golang.org/genproto/googleapis/api/httpbody"
)

func main() {
	ctx := context.Background()
	c, err := gateway.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &httpbodypb.HttpBody{
		// TODO: Fill request struct fields.
	}
	resp, err := c.DeleteResource(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetResource

func (c *Client) GetResource(ctx context.Context, req *httpbodypb.HttpBody, opts ...gax.CallOption) (*httpbodypb.HttpBody, error)

GetResource getResource performs an HTTP GET request on the Kubernetes API Server.

Example

package main

import (
	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1beta1"
	"context"
	httpbodypb "google.golang.org/genproto/googleapis/api/httpbody"
)

func main() {
	ctx := context.Background()
	c, err := gateway.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &httpbodypb.HttpBody{
		// TODO: Fill request struct fields.
	}
	resp, err := c.GetResource(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) PatchResource

func (c *Client) PatchResource(ctx context.Context, req *httpbodypb.HttpBody, opts ...gax.CallOption) (*httpbodypb.HttpBody, error)

PatchResource patchResource performs an HTTP PATCH on the Kubernetes API Server.

Example

package main

import (
	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1beta1"
	"context"
	httpbodypb "google.golang.org/genproto/googleapis/api/httpbody"
)

func main() {
	ctx := context.Background()
	c, err := gateway.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &httpbodypb.HttpBody{
		// TODO: Fill request struct fields.
	}
	resp, err := c.PatchResource(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) PostResource

func (c *Client) PostResource(ctx context.Context, req *httpbodypb.HttpBody, opts ...gax.CallOption) (*httpbodypb.HttpBody, error)

PostResource postResource performs an HTTP POST on the Kubernetes API Server.

Example

package main

import (
	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1beta1"
	"context"
	httpbodypb "google.golang.org/genproto/googleapis/api/httpbody"
)

func main() {
	ctx := context.Background()
	c, err := gateway.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &httpbodypb.HttpBody{
		// TODO: Fill request struct fields.
	}
	resp, err := c.PostResource(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) PutResource

func (c *Client) PutResource(ctx context.Context, req *httpbodypb.HttpBody, opts ...gax.CallOption) (*httpbodypb.HttpBody, error)

PutResource putResource performs an HTTP PUT on the Kubernetes API Server.

Example

package main

import (
	gateway "cloud.google.com/go/gkeconnect/gateway/apiv1beta1"
	"context"
	httpbodypb "google.golang.org/genproto/googleapis/api/httpbody"
)

func main() {
	ctx := context.Background()
	c, err := gateway.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &httpbodypb.HttpBody{
		// TODO: Fill request struct fields.
	}
	resp, err := c.PutResource(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}