GKE Hub API v1beta1 - Package cloud.google.com/go/gkehub/apiv1beta1 (v0.83.0)

Package gkehub is an auto-generated package for the GKE Hub.

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.

CreateMembershipOperation

type CreateMembershipOperation struct {
	// contains filtered or unexported fields
}

CreateMembershipOperation manages a long-running operation from CreateMembership.

func (*CreateMembershipOperation) Done

func (op *CreateMembershipOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateMembershipOperation) Metadata

func (op *CreateMembershipOperation) Metadata() (*gkehubpb.OperationMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateMembershipOperation) Name

func (op *CreateMembershipOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateMembershipOperation) Poll

func (op *CreateMembershipOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkehubpb.Membership, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateMembershipOperation) Wait

func (op *CreateMembershipOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkehubpb.Membership, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteMembershipOperation

type DeleteMembershipOperation struct {
	// contains filtered or unexported fields
}

DeleteMembershipOperation manages a long-running operation from DeleteMembership.

func (*DeleteMembershipOperation) Done

func (op *DeleteMembershipOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteMembershipOperation) Metadata

func (op *DeleteMembershipOperation) Metadata() (*gkehubpb.OperationMetadata, error)

func (*DeleteMembershipOperation) Name

func (op *DeleteMembershipOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteMembershipOperation) Poll

func (op *DeleteMembershipOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

func (*DeleteMembershipOperation) Wait

func (op *DeleteMembershipOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

GkeHubMembershipCallOptions

type GkeHubMembershipCallOptions struct {
	ListMemberships             []gax.CallOption
	GetMembership               []gax.CallOption
	CreateMembership            []gax.CallOption
	DeleteMembership            []gax.CallOption
	UpdateMembership            []gax.CallOption
	GenerateConnectManifest     []gax.CallOption
	ValidateExclusivity         []gax.CallOption
	GenerateExclusivityManifest []gax.CallOption
}

GkeHubMembershipCallOptions contains the retry settings for each method of GkeHubMembershipClient.

GkeHubMembershipClient

type GkeHubMembershipClient struct {

	// The call options for this service.
	CallOptions *GkeHubMembershipCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

GkeHubMembershipClient is a client for interacting with GKE Hub. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

GKE Hub CRUD API for the Membership resource. The Membership service is currently only available in the global location.

func NewGkeHubMembershipClient

func NewGkeHubMembershipClient(ctx context.Context, opts ...option.ClientOption) (*GkeHubMembershipClient, error)

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

GKE Hub CRUD API for the Membership resource. The Membership service is currently only available in the global location.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"
)

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

	// TODO: Use client.
	_ = c
}

func (*GkeHubMembershipClient) Close

func (c *GkeHubMembershipClient) Close() error

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

func (*GkeHubMembershipClient) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*GkeHubMembershipClient) CreateMembership

func (c *GkeHubMembershipClient) CreateMembership(ctx context.Context, req *gkehubpb.CreateMembershipRequest, opts ...gax.CallOption) (*CreateMembershipOperation, error)

CreateMembership adds a new Membership.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

	req := &gkehubpb.CreateMembershipRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.CreateMembership(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*GkeHubMembershipClient) CreateMembershipOperation

func (c *GkeHubMembershipClient) CreateMembershipOperation(name string) *CreateMembershipOperation

CreateMembershipOperation returns a new CreateMembershipOperation from a given name. The name must be that of a previously created CreateMembershipOperation, possibly from a different process.

func (*GkeHubMembershipClient) DeleteMembership

func (c *GkeHubMembershipClient) DeleteMembership(ctx context.Context, req *gkehubpb.DeleteMembershipRequest, opts ...gax.CallOption) (*DeleteMembershipOperation, error)

DeleteMembership removes a Membership.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

	req := &gkehubpb.DeleteMembershipRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.DeleteMembership(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*GkeHubMembershipClient) DeleteMembershipOperation

func (c *GkeHubMembershipClient) DeleteMembershipOperation(name string) *DeleteMembershipOperation

DeleteMembershipOperation returns a new DeleteMembershipOperation from a given name. The name must be that of a previously created DeleteMembershipOperation, possibly from a different process.

func (*GkeHubMembershipClient) GenerateConnectManifest

func (c *GkeHubMembershipClient) GenerateConnectManifest(ctx context.Context, req *gkehubpb.GenerateConnectManifestRequest, opts ...gax.CallOption) (*gkehubpb.GenerateConnectManifestResponse, error)

GenerateConnectManifest generates the manifest for deployment of the GKE connect agent.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

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

func (*GkeHubMembershipClient) GenerateExclusivityManifest

func (c *GkeHubMembershipClient) GenerateExclusivityManifest(ctx context.Context, req *gkehubpb.GenerateExclusivityManifestRequest, opts ...gax.CallOption) (*gkehubpb.GenerateExclusivityManifestResponse, error)

GenerateExclusivityManifest generateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed.

Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub.

The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

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

func (*GkeHubMembershipClient) GetMembership

func (c *GkeHubMembershipClient) GetMembership(ctx context.Context, req *gkehubpb.GetMembershipRequest, opts ...gax.CallOption) (*gkehubpb.Membership, error)

GetMembership gets the details of a Membership.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

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

func (*GkeHubMembershipClient) ListMemberships

func (c *GkeHubMembershipClient) ListMemberships(ctx context.Context, req *gkehubpb.ListMembershipsRequest, opts ...gax.CallOption) *MembershipIterator

ListMemberships lists Memberships in a given project and location.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"
	"google.golang.org/api/iterator"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

	req := &gkehubpb.ListMembershipsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListMemberships(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*GkeHubMembershipClient) UpdateMembership

func (c *GkeHubMembershipClient) UpdateMembership(ctx context.Context, req *gkehubpb.UpdateMembershipRequest, opts ...gax.CallOption) (*UpdateMembershipOperation, error)

UpdateMembership updates an existing Membership.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

	req := &gkehubpb.UpdateMembershipRequest{
		// TODO: Fill request struct fields.
	}
	op, err := c.UpdateMembership(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*GkeHubMembershipClient) UpdateMembershipOperation

func (c *GkeHubMembershipClient) UpdateMembershipOperation(name string) *UpdateMembershipOperation

UpdateMembershipOperation returns a new UpdateMembershipOperation from a given name. The name must be that of a previously created UpdateMembershipOperation, possibly from a different process.

func (*GkeHubMembershipClient) ValidateExclusivity

func (c *GkeHubMembershipClient) ValidateExclusivity(ctx context.Context, req *gkehubpb.ValidateExclusivityRequest, opts ...gax.CallOption) (*gkehubpb.ValidateExclusivityResponse, error)

ValidateExclusivity validateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

Example

package main

import (
	"context"

	gkehub "cloud.google.com/go/gkehub/apiv1beta1"

	gkehubpb "google.golang.org/genproto/googleapis/cloud/gkehub/v1beta1"
)

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

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

MembershipIterator

type MembershipIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*gkehubpb.Membership, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MembershipIterator manages a stream of *gkehubpb.Membership.

func (*MembershipIterator) Next

func (it *MembershipIterator) Next() (*gkehubpb.Membership, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MembershipIterator) PageInfo

func (it *MembershipIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

UpdateMembershipOperation

type UpdateMembershipOperation struct {
	// contains filtered or unexported fields
}

UpdateMembershipOperation manages a long-running operation from UpdateMembership.

func (*UpdateMembershipOperation) Done

func (op *UpdateMembershipOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateMembershipOperation) Metadata

func (op *UpdateMembershipOperation) Metadata() (*gkehubpb.OperationMetadata, error)

func (*UpdateMembershipOperation) Name

func (op *UpdateMembershipOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateMembershipOperation) Poll

func (op *UpdateMembershipOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkehubpb.Membership, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

func (*UpdateMembershipOperation) Wait

func (op *UpdateMembershipOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkehubpb.Membership, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.