admin

package
v1.50.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2026 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Overview

Package admin is an auto-generated package for the Cloud Bigtable Admin API.

Administer your Cloud Bigtable tables and instances.

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:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/bigtable/admin/apiv2@latest
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 := admin.NewBigtableInstanceAdminClient(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, mentioned above.

req := &adminpb.CreateAppProfileRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#CreateAppProfileRequest.
}
resp, err := c.CreateAppProfile(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

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

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

type AppProfileIterator

type AppProfileIterator 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 []*adminpb.AppProfile, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AppProfileIterator manages a stream of *adminpb.AppProfile.

func (*AppProfileIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*AppProfileIterator) Next

func (it *AppProfileIterator) Next() (*adminpb.AppProfile, 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 (*AppProfileIterator) PageInfo

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

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

type AuthorizedViewIterator

type AuthorizedViewIterator 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 []*adminpb.AuthorizedView, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AuthorizedViewIterator manages a stream of *adminpb.AuthorizedView.

func (*AuthorizedViewIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*AuthorizedViewIterator) Next

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 (*AuthorizedViewIterator) PageInfo

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

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

type BackupIterator

type BackupIterator 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 []*adminpb.Backup, nextPageToken string, err error)
	// contains filtered or unexported fields
}

BackupIterator manages a stream of *adminpb.Backup.

func (*BackupIterator) All

func (it *BackupIterator) All() iter.Seq2[*adminpb.Backup, error]

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*BackupIterator) Next

func (it *BackupIterator) Next() (*adminpb.Backup, 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 (*BackupIterator) PageInfo

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

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

type BigtableInstanceAdminCallOptions

type BigtableInstanceAdminCallOptions struct {
	CreateInstance         []gax.CallOption
	GetInstance            []gax.CallOption
	ListInstances          []gax.CallOption
	UpdateInstance         []gax.CallOption
	PartialUpdateInstance  []gax.CallOption
	DeleteInstance         []gax.CallOption
	CreateCluster          []gax.CallOption
	GetCluster             []gax.CallOption
	ListClusters           []gax.CallOption
	UpdateCluster          []gax.CallOption
	PartialUpdateCluster   []gax.CallOption
	DeleteCluster          []gax.CallOption
	CreateAppProfile       []gax.CallOption
	GetAppProfile          []gax.CallOption
	ListAppProfiles        []gax.CallOption
	UpdateAppProfile       []gax.CallOption
	DeleteAppProfile       []gax.CallOption
	GetIamPolicy           []gax.CallOption
	SetIamPolicy           []gax.CallOption
	TestIamPermissions     []gax.CallOption
	ListHotTablets         []gax.CallOption
	CreateLogicalView      []gax.CallOption
	GetLogicalView         []gax.CallOption
	ListLogicalViews       []gax.CallOption
	UpdateLogicalView      []gax.CallOption
	DeleteLogicalView      []gax.CallOption
	CreateMaterializedView []gax.CallOption
	GetMaterializedView    []gax.CallOption
	ListMaterializedViews  []gax.CallOption
	UpdateMaterializedView []gax.CallOption
	DeleteMaterializedView []gax.CallOption
}

BigtableInstanceAdminCallOptions contains the retry settings for each method of BigtableInstanceAdminClient.

type BigtableInstanceAdminClient

type BigtableInstanceAdminClient struct {

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

	// 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
}

BigtableInstanceAdminClient is a client for interacting with Cloud Bigtable Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables’ metadata or data stored in those tables.

func NewBigtableInstanceAdminClient

func NewBigtableInstanceAdminClient(ctx context.Context, opts ...option.ClientOption) (*BigtableInstanceAdminClient, error)

NewBigtableInstanceAdminClient creates a new bigtable instance admin client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables’ metadata or data stored in those tables.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*BigtableInstanceAdminClient) Close

Close closes the connection to the API service. **Always** call Close() when the client is no longer required.

func (*BigtableInstanceAdminClient) Connection deprecated

func (c *BigtableInstanceAdminClient) 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 (*BigtableInstanceAdminClient) CreateAppProfile

CreateAppProfile creates an app profile within an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.CreateAppProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#CreateAppProfileRequest.
	}
	resp, err := c.CreateAppProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) CreateCluster

CreateCluster creates a cluster within an instance.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.CreateClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#CreateClusterRequest.
	}
	op, err := c.CreateCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) CreateClusterOperation

func (c *BigtableInstanceAdminClient) CreateClusterOperation(name string) *CreateClusterOperation

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

func (*BigtableInstanceAdminClient) CreateInstance

CreateInstance create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.CreateInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#CreateInstanceRequest.
	}
	op, err := c.CreateInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) CreateInstanceOperation

func (c *BigtableInstanceAdminClient) CreateInstanceOperation(name string) *CreateInstanceOperation

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

func (*BigtableInstanceAdminClient) CreateLogicalView

CreateLogicalView creates a logical view within an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.CreateLogicalViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#CreateLogicalViewRequest.
	}
	op, err := c.CreateLogicalView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) CreateLogicalViewOperation

func (c *BigtableInstanceAdminClient) CreateLogicalViewOperation(name string) *CreateLogicalViewOperation

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

func (*BigtableInstanceAdminClient) CreateMaterializedView

CreateMaterializedView creates a materialized view within an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.CreateMaterializedViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#CreateMaterializedViewRequest.
	}
	op, err := c.CreateMaterializedView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) CreateMaterializedViewOperation

func (c *BigtableInstanceAdminClient) CreateMaterializedViewOperation(name string) *CreateMaterializedViewOperation

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

func (*BigtableInstanceAdminClient) DeleteAppProfile

DeleteAppProfile deletes an app profile from an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.DeleteAppProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#DeleteAppProfileRequest.
	}
	err = c.DeleteAppProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*BigtableInstanceAdminClient) DeleteCluster

DeleteCluster deletes a cluster from an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.DeleteClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#DeleteClusterRequest.
	}
	err = c.DeleteCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*BigtableInstanceAdminClient) DeleteInstance

DeleteInstance delete an instance from a project.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.DeleteInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#DeleteInstanceRequest.
	}
	err = c.DeleteInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*BigtableInstanceAdminClient) DeleteLogicalView

DeleteLogicalView deletes a logical view from an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.DeleteLogicalViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#DeleteLogicalViewRequest.
	}
	err = c.DeleteLogicalView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*BigtableInstanceAdminClient) DeleteMaterializedView

DeleteMaterializedView deletes a materialized view from an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.DeleteMaterializedViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#DeleteMaterializedViewRequest.
	}
	err = c.DeleteMaterializedView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*BigtableInstanceAdminClient) GetAppProfile

GetAppProfile gets information about an app profile.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.GetAppProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#GetAppProfileRequest.
	}
	resp, err := c.GetAppProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) GetCluster

GetCluster gets information about a cluster.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.GetClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#GetClusterRequest.
	}
	resp, err := c.GetCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) GetIamPolicy

GetIamPolicy gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"

	iampb "cloud.google.com/go/iam/apiv1/iampb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

func (*BigtableInstanceAdminClient) GetInstance

GetInstance gets information about an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.GetInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#GetInstanceRequest.
	}
	resp, err := c.GetInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) GetLogicalView

GetLogicalView gets information about a logical view.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.GetLogicalViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#GetLogicalViewRequest.
	}
	resp, err := c.GetLogicalView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) GetMaterializedView

GetMaterializedView gets information about a materialized view.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.GetMaterializedViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#GetMaterializedViewRequest.
	}
	resp, err := c.GetMaterializedView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) ListAppProfiles

ListAppProfiles lists information about app profiles in an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
	"google.golang.org/api/iterator"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListAppProfilesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListAppProfilesRequest.
	}
	it := c.ListAppProfiles(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*adminpb.ListAppProfilesResponse)
	}
}
Example (All)
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListAppProfilesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListAppProfilesRequest.
	}
	for resp, err := range c.ListAppProfiles(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*BigtableInstanceAdminClient) ListClusters

ListClusters lists information about clusters in an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListClustersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListClustersRequest.
	}
	resp, err := c.ListClusters(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) ListHotTablets

ListHotTablets lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
	"google.golang.org/api/iterator"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListHotTabletsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListHotTabletsRequest.
	}
	it := c.ListHotTablets(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*adminpb.ListHotTabletsResponse)
	}
}
Example (All)
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListHotTabletsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListHotTabletsRequest.
	}
	for resp, err := range c.ListHotTablets(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*BigtableInstanceAdminClient) ListInstances

ListInstances lists information about instances in a project.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListInstancesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListInstancesRequest.
	}
	resp, err := c.ListInstances(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) ListLogicalViews

ListLogicalViews lists information about logical views in an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
	"google.golang.org/api/iterator"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListLogicalViewsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListLogicalViewsRequest.
	}
	it := c.ListLogicalViews(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*adminpb.ListLogicalViewsResponse)
	}
}
Example (All)
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListLogicalViewsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListLogicalViewsRequest.
	}
	for resp, err := range c.ListLogicalViews(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*BigtableInstanceAdminClient) ListMaterializedViews

ListMaterializedViews lists information about materialized views in an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
	"google.golang.org/api/iterator"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListMaterializedViewsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListMaterializedViewsRequest.
	}
	it := c.ListMaterializedViews(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*adminpb.ListMaterializedViewsResponse)
	}
}
Example (All)
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.ListMaterializedViewsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#ListMaterializedViewsRequest.
	}
	for resp, err := range c.ListMaterializedViews(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*BigtableInstanceAdminClient) PartialUpdateCluster

PartialUpdateCluster partially updates a cluster within a project. This method is the preferred way to update a Cluster.

To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.

To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.PartialUpdateClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#PartialUpdateClusterRequest.
	}
	op, err := c.PartialUpdateCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) PartialUpdateClusterOperation

func (c *BigtableInstanceAdminClient) PartialUpdateClusterOperation(name string) *PartialUpdateClusterOperation

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

func (*BigtableInstanceAdminClient) PartialUpdateInstance

PartialUpdateInstance partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.PartialUpdateInstanceRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#PartialUpdateInstanceRequest.
	}
	op, err := c.PartialUpdateInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) PartialUpdateInstanceOperation

func (c *BigtableInstanceAdminClient) PartialUpdateInstanceOperation(name string) *PartialUpdateInstanceOperation

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

func (*BigtableInstanceAdminClient) SetIamPolicy

SetIamPolicy sets the access control policy on an instance resource. Replaces any existing policy.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"

	iampb "cloud.google.com/go/iam/apiv1/iampb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

func (*BigtableInstanceAdminClient) TestIamPermissions

TestIamPermissions returns permissions that the caller has on the specified instance resource.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"

	iampb "cloud.google.com/go/iam/apiv1/iampb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

func (*BigtableInstanceAdminClient) UpdateAppProfile

UpdateAppProfile updates an app profile within an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.UpdateAppProfileRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#UpdateAppProfileRequest.
	}
	op, err := c.UpdateAppProfile(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) UpdateAppProfileOperation

func (c *BigtableInstanceAdminClient) UpdateAppProfileOperation(name string) *UpdateAppProfileOperation

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

func (*BigtableInstanceAdminClient) UpdateCluster

UpdateCluster updates a cluster within an instance.

Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.Cluster{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#Cluster.
	}
	op, err := c.UpdateCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) UpdateClusterOperation

func (c *BigtableInstanceAdminClient) UpdateClusterOperation(name string) *UpdateClusterOperation

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

func (*BigtableInstanceAdminClient) UpdateInstance

func (c *BigtableInstanceAdminClient) UpdateInstance(ctx context.Context, req *adminpb.Instance, opts ...gax.CallOption) (*adminpb.Instance, error)

UpdateInstance updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.Instance{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#Instance.
	}
	resp, err := c.UpdateInstance(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*BigtableInstanceAdminClient) UpdateLogicalView

UpdateLogicalView updates a logical view within an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.UpdateLogicalViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#UpdateLogicalViewRequest.
	}
	op, err := c.UpdateLogicalView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) UpdateLogicalViewOperation

func (c *BigtableInstanceAdminClient) UpdateLogicalViewOperation(name string) *UpdateLogicalViewOperation

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

func (*BigtableInstanceAdminClient) UpdateMaterializedView

UpdateMaterializedView updates a materialized view within an instance.

Example
package main

import (
	"context"

	admin "cloud.google.com/go/bigtable/admin/apiv2"
	adminpb "cloud.google.com/go/bigtable/admin/apiv2/adminpb"
)

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 := admin.NewBigtableInstanceAdminClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &adminpb.UpdateMaterializedViewRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/bigtable/admin/apiv2/adminpb#UpdateMaterializedViewRequest.
	}
	op, err := c.UpdateMaterializedView(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*BigtableInstanceAdminClient) UpdateMaterializedViewOperation

func (c *BigtableInstanceAdminClient) UpdateMaterializedViewOperation(name string) *UpdateMaterializedViewOperation

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

type BigtableTableAdminCallOptions

type BigtableTableAdminCallOptions struct {
	CreateTable              []gax.CallOption
	CreateTableFromSnapshot  []gax.CallOption
	ListTables               []gax.CallOption
	GetTable                 []gax.CallOption
	UpdateTable              []gax.CallOption
	DeleteTable              []gax.CallOption
	UndeleteTable            []gax.CallOption
	CreateAuthorizedView     []gax.CallOption
	ListAuthorizedViews      []gax.CallOption
	GetAuthorizedView        []gax.CallOption
	UpdateAuthorizedView     []gax.CallOption
	DeleteAuthorizedView     []gax.CallOption
	ModifyColumnFamilies     []gax.CallOption
	DropRowRange             []gax.CallOption
	GenerateConsistencyToken []gax.CallOption
	CheckConsistency         []gax.CallOption
	SnapshotTable            []gax.CallOption
	GetSnapshot              []gax.CallOption
	ListSnapshots            []gax.CallOption
	DeleteSnapshot           []gax.CallOption
	CreateBackup             []gax.CallOption
	GetBackup                []gax.CallOption
	UpdateBackup             []gax.CallOption
	DeleteBackup             []gax.CallOption
	ListBackups              []gax.CallOption
	RestoreTable             []gax.CallOption
	CopyBackup               []gax.CallOption
	GetIamPolicy             []gax.CallOption
	SetIamPolicy             []gax.CallOption
	TestIamPermissions       []gax.CallOption
	CreateSchemaBundle       []gax.CallOption
	UpdateSchemaBundle       []gax.CallOption
	GetSchemaBundle          []gax.CallOption
	ListSchemaBundles        []gax.CallOption
	DeleteSchemaBundle       []gax.CallOption
}

BigtableTableAdminCallOptions contains the retry settings for each method of BigtableTableAdminClient.

type BigtableTableAdminClient

type BigtableTableAdminClient struct {

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

	// 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
}

BigtableTableAdminClient is a client for interacting with Cloud Bigtable Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

func NewBigtableTableAdminClient

func NewBigtableTableAdminClient(ctx context.Context, opts ...option.ClientOption) (*BigtableTableAdminClient, error)

NewBigtableTableAdminClient creates a new bigtable table admin client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

func (*BigtableTableAdminClient) CheckConsistency

CheckConsistency checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

func (*BigtableTableAdminClient) Close

func (c *BigtableTableAdminClient) Close() error

Close closes the connection to the API service. **Always** call Close() when the client is no longer required.

func (*BigtableTableAdminClient) Connection deprecated

func (c *BigtableTableAdminClient) 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 (*BigtableTableAdminClient) CopyBackup

CopyBackup copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

func (*BigtableTableAdminClient) CopyBackupOperation

func (c *BigtableTableAdminClient) CopyBackupOperation(name string) *CopyBackupOperation

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

func (*BigtableTableAdminClient) CreateAuthorizedView

CreateAuthorizedView creates a new AuthorizedView in a table.

func (*BigtableTableAdminClient) CreateAuthorizedViewOperation

func (c *BigtableTableAdminClient) CreateAuthorizedViewOperation(name string) *CreateAuthorizedViewOperation

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

func (*BigtableTableAdminClient) CreateBackup

CreateBackup starts creating a new Cloud Bigtable Backup. The returned backup [long-running operation][google.longrunning.Operation] can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

func (*BigtableTableAdminClient) CreateBackupOperation

func (c *BigtableTableAdminClient) CreateBackupOperation(name string) *CreateBackupOperation

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

func (*BigtableTableAdminClient) CreateSchemaBundle

CreateSchemaBundle creates a new schema bundle in the specified table.

func (*BigtableTableAdminClient) CreateSchemaBundleOperation

func (c *BigtableTableAdminClient) CreateSchemaBundleOperation(name string) *CreateSchemaBundleOperation

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

func (*BigtableTableAdminClient) CreateTable

CreateTable creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

func (*BigtableTableAdminClient) CreateTableFromSnapshot

CreateTableFromSnapshot creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

func (*BigtableTableAdminClient) CreateTableFromSnapshotOperation

func (c *BigtableTableAdminClient) CreateTableFromSnapshotOperation(name string) *CreateTableFromSnapshotOperation

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

func (*BigtableTableAdminClient) DeleteAuthorizedView

func (c *BigtableTableAdminClient) DeleteAuthorizedView(ctx context.Context, req *adminpb.DeleteAuthorizedViewRequest, opts ...gax.CallOption) error

DeleteAuthorizedView permanently deletes a specified AuthorizedView.

func (*BigtableTableAdminClient) DeleteBackup

DeleteBackup deletes a pending or completed Cloud Bigtable backup.

func (*BigtableTableAdminClient) DeleteSchemaBundle

DeleteSchemaBundle deletes a schema bundle in the specified table.

func (*BigtableTableAdminClient) DeleteSnapshot

DeleteSnapshot permanently deletes the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

func (*BigtableTableAdminClient) DeleteTable

DeleteTable permanently deletes a specified table and all of its data.

func (*BigtableTableAdminClient) DropRowRange

DropRowRange permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

func (*BigtableTableAdminClient) GenerateConsistencyToken

GenerateConsistencyToken generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.

func (*BigtableTableAdminClient) GetAuthorizedView

GetAuthorizedView gets information from a specified AuthorizedView.

func (*BigtableTableAdminClient) GetBackup

GetBackup gets metadata on a pending or completed Cloud Bigtable Backup.

func (*BigtableTableAdminClient) GetIamPolicy

GetIamPolicy gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

func (*BigtableTableAdminClient) GetSchemaBundle

GetSchemaBundle gets metadata information about the specified schema bundle.

func (*BigtableTableAdminClient) GetSnapshot

GetSnapshot gets metadata information about the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

func (*BigtableTableAdminClient) GetTable

GetTable gets metadata information about the specified table.

func (*BigtableTableAdminClient) ListAuthorizedViews

ListAuthorizedViews lists all AuthorizedViews from a specific table.

func (*BigtableTableAdminClient) ListBackups

ListBackups lists Cloud Bigtable backups. Returns both completed and pending backups.

func (*BigtableTableAdminClient) ListSchemaBundles

ListSchemaBundles lists all schema bundles associated with the specified table.

func (*BigtableTableAdminClient) ListSnapshots

ListSnapshots lists all snapshots associated with the specified cluster.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

func (*BigtableTableAdminClient) ListTables

ListTables lists all tables served from a specified instance.

func (*BigtableTableAdminClient) ModifyColumnFamilies

ModifyColumnFamilies performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

func (*BigtableTableAdminClient) RestoreTable

RestoreTable creates a new table by restoring from a backup.

func (*BigtableTableAdminClient) SetIamPolicy

SetIamPolicy sets the access control policy on a Bigtable resource. Replaces any existing policy.

func (*BigtableTableAdminClient) SnapshotTable

SnapshotTable creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

func (*BigtableTableAdminClient) SnapshotTableOperation

func (c *BigtableTableAdminClient) SnapshotTableOperation(name string) *SnapshotTableOperation

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

func (*BigtableTableAdminClient) TestIamPermissions

TestIamPermissions returns permissions that the caller has on the specified Bigtable resource.

func (*BigtableTableAdminClient) UndeleteTable

UndeleteTable restores a specified table which was accidentally deleted.

func (*BigtableTableAdminClient) UndeleteTableOperation

func (c *BigtableTableAdminClient) UndeleteTableOperation(name string) *UndeleteTableOperation

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

func (*BigtableTableAdminClient) UpdateAuthorizedView

UpdateAuthorizedView updates an AuthorizedView in a table.

func (*BigtableTableAdminClient) UpdateAuthorizedViewOperation

func (c *BigtableTableAdminClient) UpdateAuthorizedViewOperation(name string) *UpdateAuthorizedViewOperation

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

func (*BigtableTableAdminClient) UpdateBackup

UpdateBackup updates a pending or completed Cloud Bigtable Backup.

func (*BigtableTableAdminClient) UpdateSchemaBundle

UpdateSchemaBundle updates a schema bundle in the specified table.

func (*BigtableTableAdminClient) UpdateSchemaBundleOperation

func (c *BigtableTableAdminClient) UpdateSchemaBundleOperation(name string) *UpdateSchemaBundleOperation

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

func (*BigtableTableAdminClient) UpdateTable

UpdateTable updates a specified table.

func (*BigtableTableAdminClient) UpdateTableOperation

func (c *BigtableTableAdminClient) UpdateTableOperation(name string) *UpdateTableOperation

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

func (*BigtableTableAdminClient) WaitForConsistency

func (c *BigtableTableAdminClient) WaitForConsistency(ctx context.Context, tableName string, opts ...gax.CallOption) error

WaitForConsistency waits until all the writes committed before the call started have been propagated to all the clusters in the instance via replication.

type CopyBackupOperation

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

CopyBackupOperation manages a long-running operation from CopyBackup.

func (*CopyBackupOperation) Done

func (op *CopyBackupOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CopyBackupOperation) Metadata

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 (*CopyBackupOperation) Name

func (op *CopyBackupOperation) 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 (*CopyBackupOperation) Poll

func (op *CopyBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Backup, 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 (*CopyBackupOperation) Wait

func (op *CopyBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Backup, 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.

type CreateAuthorizedViewOperation

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

CreateAuthorizedViewOperation manages a long-running operation from CreateAuthorizedView.

func (*CreateAuthorizedViewOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateAuthorizedViewOperation) Metadata

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 (*CreateAuthorizedViewOperation) Name

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 (*CreateAuthorizedViewOperation) Poll

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 (*CreateAuthorizedViewOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateBackupOperation

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

CreateBackupOperation manages a long-running operation from CreateBackup.

func (*CreateBackupOperation) Done

func (op *CreateBackupOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateBackupOperation) Metadata

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 (*CreateBackupOperation) Name

func (op *CreateBackupOperation) 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 (*CreateBackupOperation) Poll

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 (*CreateBackupOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateClusterOperation

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

CreateClusterOperation manages a long-running operation from CreateCluster.

func (*CreateClusterOperation) Done

func (op *CreateClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateClusterOperation) Metadata

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 (*CreateClusterOperation) Name

func (op *CreateClusterOperation) 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 (*CreateClusterOperation) Poll

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 (*CreateClusterOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateInstanceOperation

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

CreateInstanceOperation manages a long-running operation from CreateInstance.

func (*CreateInstanceOperation) Done

func (op *CreateInstanceOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateInstanceOperation) Metadata

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 (*CreateInstanceOperation) Name

func (op *CreateInstanceOperation) 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 (*CreateInstanceOperation) Poll

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 (*CreateInstanceOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateLogicalViewOperation

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

CreateLogicalViewOperation manages a long-running operation from CreateLogicalView.

func (*CreateLogicalViewOperation) Done

func (op *CreateLogicalViewOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateLogicalViewOperation) Metadata

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 (*CreateLogicalViewOperation) Name

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 (*CreateLogicalViewOperation) Poll

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 (*CreateLogicalViewOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateMaterializedViewOperation

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

CreateMaterializedViewOperation manages a long-running operation from CreateMaterializedView.

func (*CreateMaterializedViewOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateMaterializedViewOperation) Metadata

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 (*CreateMaterializedViewOperation) Name

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 (*CreateMaterializedViewOperation) Poll

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 (*CreateMaterializedViewOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateSchemaBundleOperation

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

CreateSchemaBundleOperation manages a long-running operation from CreateSchemaBundle.

func (*CreateSchemaBundleOperation) Done

func (op *CreateSchemaBundleOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateSchemaBundleOperation) Metadata

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 (*CreateSchemaBundleOperation) Name

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 (*CreateSchemaBundleOperation) Poll

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 (*CreateSchemaBundleOperation) Wait

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

See documentation of Poll for error-handling information.

type CreateTableFromSnapshotOperation

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

CreateTableFromSnapshotOperation manages a long-running operation from CreateTableFromSnapshot.

func (*CreateTableFromSnapshotOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateTableFromSnapshotOperation) Metadata

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 (*CreateTableFromSnapshotOperation) Name

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 (*CreateTableFromSnapshotOperation) Poll

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 (*CreateTableFromSnapshotOperation) Wait

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

See documentation of Poll for error-handling information.

type HotTabletIterator

type HotTabletIterator 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 []*adminpb.HotTablet, nextPageToken string, err error)
	// contains filtered or unexported fields
}

HotTabletIterator manages a stream of *adminpb.HotTablet.

func (*HotTabletIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*HotTabletIterator) Next

func (it *HotTabletIterator) Next() (*adminpb.HotTablet, 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 (*HotTabletIterator) PageInfo

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

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

type LogicalViewIterator

type LogicalViewIterator 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 []*adminpb.LogicalView, nextPageToken string, err error)
	// contains filtered or unexported fields
}

LogicalViewIterator manages a stream of *adminpb.LogicalView.

func (*LogicalViewIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*LogicalViewIterator) Next

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 (*LogicalViewIterator) PageInfo

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

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

type MaterializedViewIterator

type MaterializedViewIterator 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 []*adminpb.MaterializedView, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MaterializedViewIterator manages a stream of *adminpb.MaterializedView.

func (*MaterializedViewIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*MaterializedViewIterator) Next

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 (*MaterializedViewIterator) PageInfo

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

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

type PartialUpdateClusterOperation

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

PartialUpdateClusterOperation manages a long-running operation from PartialUpdateCluster.

func (*PartialUpdateClusterOperation) Done

Done reports whether the long-running operation has completed.

func (*PartialUpdateClusterOperation) Metadata

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 (*PartialUpdateClusterOperation) Name

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 (*PartialUpdateClusterOperation) Poll

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 (*PartialUpdateClusterOperation) Wait

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

See documentation of Poll for error-handling information.

type PartialUpdateInstanceOperation

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

PartialUpdateInstanceOperation manages a long-running operation from PartialUpdateInstance.

func (*PartialUpdateInstanceOperation) Done

Done reports whether the long-running operation has completed.

func (*PartialUpdateInstanceOperation) Metadata

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 (*PartialUpdateInstanceOperation) Name

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 (*PartialUpdateInstanceOperation) Poll

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 (*PartialUpdateInstanceOperation) Wait

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

See documentation of Poll for error-handling information.

type RestoreTableOperation

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

RestoreTableOperation manages a long-running operation from RestoreTable.

func (*RestoreTableOperation) Done

func (op *RestoreTableOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RestoreTableOperation) Metadata

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 (*RestoreTableOperation) Name

func (op *RestoreTableOperation) 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 (*RestoreTableOperation) Poll

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 (*RestoreTableOperation) Wait

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

See documentation of Poll for error-handling information.

type SchemaBundleIterator

type SchemaBundleIterator 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 []*adminpb.SchemaBundle, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SchemaBundleIterator manages a stream of *adminpb.SchemaBundle.

func (*SchemaBundleIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*SchemaBundleIterator) Next

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 (*SchemaBundleIterator) PageInfo

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

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

type SnapshotIterator

type SnapshotIterator 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 []*adminpb.Snapshot, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SnapshotIterator manages a stream of *adminpb.Snapshot.

func (*SnapshotIterator) All

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*SnapshotIterator) Next

func (it *SnapshotIterator) Next() (*adminpb.Snapshot, 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 (*SnapshotIterator) PageInfo

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

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

type SnapshotTableOperation

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

SnapshotTableOperation manages a long-running operation from SnapshotTable.

func (*SnapshotTableOperation) Done

func (op *SnapshotTableOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*SnapshotTableOperation) Metadata

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 (*SnapshotTableOperation) Name

func (op *SnapshotTableOperation) 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 (*SnapshotTableOperation) Poll

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 (*SnapshotTableOperation) Wait

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

See documentation of Poll for error-handling information.

type TableIterator

type TableIterator 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 []*adminpb.Table, nextPageToken string, err error)
	// contains filtered or unexported fields
}

TableIterator manages a stream of *adminpb.Table.

func (*TableIterator) All

func (it *TableIterator) All() iter.Seq2[*adminpb.Table, error]

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*TableIterator) Next

func (it *TableIterator) Next() (*adminpb.Table, 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 (*TableIterator) PageInfo

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

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

type UndeleteTableOperation

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

UndeleteTableOperation manages a long-running operation from UndeleteTable.

func (*UndeleteTableOperation) Done

func (op *UndeleteTableOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UndeleteTableOperation) Metadata

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 (*UndeleteTableOperation) Name

func (op *UndeleteTableOperation) 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 (*UndeleteTableOperation) Poll

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 (*UndeleteTableOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateAppProfileOperation

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

UpdateAppProfileOperation manages a long-running operation from UpdateAppProfile.

func (*UpdateAppProfileOperation) Done

func (op *UpdateAppProfileOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateAppProfileOperation) Metadata

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 (*UpdateAppProfileOperation) Name

func (op *UpdateAppProfileOperation) 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 (*UpdateAppProfileOperation) Poll

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 (*UpdateAppProfileOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateAuthorizedViewOperation

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

UpdateAuthorizedViewOperation manages a long-running operation from UpdateAuthorizedView.

func (*UpdateAuthorizedViewOperation) Done

Done reports whether the long-running operation has completed.

func (*UpdateAuthorizedViewOperation) Metadata

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 (*UpdateAuthorizedViewOperation) Name

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 (*UpdateAuthorizedViewOperation) Poll

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 (*UpdateAuthorizedViewOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateClusterOperation

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

UpdateClusterOperation manages a long-running operation from UpdateCluster.

func (*UpdateClusterOperation) Done

func (op *UpdateClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateClusterOperation) Metadata

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 (*UpdateClusterOperation) Name

func (op *UpdateClusterOperation) 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 (*UpdateClusterOperation) Poll

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 (*UpdateClusterOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateLogicalViewOperation

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

UpdateLogicalViewOperation manages a long-running operation from UpdateLogicalView.

func (*UpdateLogicalViewOperation) Done

func (op *UpdateLogicalViewOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateLogicalViewOperation) Metadata

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 (*UpdateLogicalViewOperation) Name

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 (*UpdateLogicalViewOperation) Poll

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 (*UpdateLogicalViewOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateMaterializedViewOperation

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

UpdateMaterializedViewOperation manages a long-running operation from UpdateMaterializedView.

func (*UpdateMaterializedViewOperation) Done

Done reports whether the long-running operation has completed.

func (*UpdateMaterializedViewOperation) Metadata

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 (*UpdateMaterializedViewOperation) Name

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 (*UpdateMaterializedViewOperation) Poll

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 (*UpdateMaterializedViewOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateSchemaBundleOperation

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

UpdateSchemaBundleOperation manages a long-running operation from UpdateSchemaBundle.

func (*UpdateSchemaBundleOperation) Done

func (op *UpdateSchemaBundleOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateSchemaBundleOperation) Metadata

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 (*UpdateSchemaBundleOperation) Name

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 (*UpdateSchemaBundleOperation) Poll

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 (*UpdateSchemaBundleOperation) Wait

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

See documentation of Poll for error-handling information.

type UpdateTableOperation

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

UpdateTableOperation manages a long-running operation from UpdateTable.

func (*UpdateTableOperation) Done

func (op *UpdateTableOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateTableOperation) Metadata

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 (*UpdateTableOperation) Name

func (op *UpdateTableOperation) 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 (*UpdateTableOperation) Poll

func (op *UpdateTableOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*adminpb.Table, 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 (*UpdateTableOperation) Wait

func (op *UpdateTableOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*adminpb.Table, 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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL