Cloud Bigtable Admin API v2 - Package cloud.google.com/go/bigtable/admin/apiv2 (v1.56.0)

1.56.0 (latest) 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.1 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.1 1.26.0 1.25.0 1.24.0 1.23.0 1.22.0 1.21.0 1.19.0 1.18.1 1.17.0 1.16.0 1.15.0 1.13.0 1.12.0 1.11.0 1.10.1 1.9.0 1.8.0 1.7.1 1.6.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

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:

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

Example usage

To get started with this package, create a client.

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

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

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

func (it *AppProfileIterator) All() iter.Seq2[*adminpb.AppProfile, error]

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.

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

func (it *AuthorizedViewIterator) All() iter.Seq2[*adminpb.AuthorizedView, error]

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

func (*AuthorizedViewIterator) Next

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

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

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

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.

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.

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

func (c *BigtableInstanceAdminClient) Close() error

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

func (c *BigtableInstanceAdminClient) CreateAppProfile(ctx context.Context, req *adminpb.CreateAppProfileRequest, opts ...gax.CallOption) (*adminpb.AppProfile, error)

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

func (c *BigtableInstanceAdminClient) CreateCluster(ctx context.Context, req *adminpb.CreateClusterRequest, opts ...gax.CallOption) (*CreateClusterOperation, error)

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

func (c *BigtableInstanceAdminClient) CreateInstance(ctx context.Context, req *adminpb.CreateInstanceRequest, opts ...gax.CallOption) (*CreateInstanceOperation, error)

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

func (c *BigtableInstanceAdminClient) CreateLogicalView(ctx context.Context, req *adminpb.CreateLogicalViewRequest, opts ...gax.CallOption) (*CreateLogicalViewOperation, error)

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

func (c *BigtableInstanceAdminClient) CreateMaterializedView(ctx context.Context, req *adminpb.CreateMaterializedViewRequest, opts ...gax.CallOption) (*CreateMaterializedViewOperation, error)

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

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

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

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

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

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

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

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

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

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

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

func (c *BigtableInstanceAdminClient) GetAppProfile(ctx context.Context, req *adminpb.GetAppProfileRequest, opts ...gax.CallOption) (*adminpb.AppProfile, error)

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

func (c *BigtableInstanceAdminClient) GetCluster(ctx context.Context, req *adminpb.GetClusterRequest, opts ...gax.CallOption) (*adminpb.Cluster, error)

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

func (c *BigtableInstanceAdminClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

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

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

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

func (c *BigtableInstanceAdminClient) GetLogicalView(ctx context.Context, req *adminpb.GetLogicalViewRequest, opts ...gax.CallOption) (*adminpb.LogicalView, error)

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

func (c *BigtableInstanceAdminClient) GetMaterializedView(ctx context.Context, req *adminpb.GetMaterializedViewRequest, opts ...gax.CallOption) (*adminpb.MaterializedView, error)

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

func (c *BigtableInstanceAdminClient) ListAppProfiles(ctx context.Context, req *adminpb.ListAppProfilesRequest, opts ...gax.CallOption) *AppProfileIterator

ListAppProfiles lists information about app profiles in an instance.

Examples

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

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

func (c *BigtableInstanceAdminClient) ListClusters(ctx context.Context, req *adminpb.ListClustersRequest, opts ...gax.CallOption) (*adminpb.ListClustersResponse, error)

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

func (c *BigtableInstanceAdminClient) ListHotTablets(ctx context.Context, req *adminpb.ListHotTabletsRequest, opts ...gax.CallOption) *HotTabletIterator

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

Examples

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

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

func (c *BigtableInstanceAdminClient) ListInstances(ctx context.Context, req *adminpb.ListInstancesRequest, opts ...gax.CallOption) (*adminpb.ListInstancesResponse, error)

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

func (c *BigtableInstanceAdminClient) ListLogicalViews(ctx context.Context, req *adminpb.ListLogicalViewsRequest, opts ...gax.CallOption) *LogicalViewIterator

ListLogicalViews lists information about logical views in an instance.

Examples

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

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

func (c *BigtableInstanceAdminClient) ListMaterializedViews(ctx context.Context, req *adminpb.ListMaterializedViewsRequest, opts ...gax.CallOption) *MaterializedViewIterator

ListMaterializedViews lists information about materialized views in an instance.

Examples

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

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

func (c *BigtableInstanceAdminClient) PartialUpdateCluster(ctx context.Context, req *adminpb.PartialUpdateClusterRequest, opts ...gax.CallOption) (*PartialUpdateClusterOperation, error)

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

func (c *BigtableInstanceAdminClient) PartialUpdateInstance(ctx context.Context, req *adminpb.PartialUpdateInstanceRequest, opts ...gax.CallOption) (*PartialUpdateInstanceOperation, error)

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

func (c *BigtableInstanceAdminClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

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

func (c *BigtableInstanceAdminClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)

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

func (c *BigtableInstanceAdminClient) UpdateAppProfile(ctx context.Context, req *adminpb.UpdateAppProfileRequest, opts ...gax.CallOption) (*UpdateAppProfileOperation, error)

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

func (c *BigtableInstanceAdminClient) UpdateCluster(ctx context.Context, req *adminpb.Cluster, opts ...gax.CallOption) (*UpdateClusterOperation, error)

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

func (c *BigtableInstanceAdminClient) UpdateLogicalView(ctx context.Context, req *adminpb.UpdateLogicalViewRequest, opts ...gax.CallOption) (*UpdateLogicalViewOperation, error)

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

func (c *BigtableInstanceAdminClient) UpdateMaterializedView(ctx context.Context, req *adminpb.UpdateMaterializedViewRequest, opts ...gax.CallOption) (*UpdateMaterializedViewOperation, error)

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.

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.

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

func (c *BigtableTableAdminClient) CheckConsistency(ctx context.Context, req *adminpb.CheckConsistencyRequest, opts ...gax.CallOption) (*adminpb.CheckConsistencyResponse, error)

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

func (c *BigtableTableAdminClient) CopyBackup(ctx context.Context, req *adminpb.CopyBackupRequest, opts ...gax.CallOption) (*CopyBackupOperation, error)

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

func (c *BigtableTableAdminClient) CreateAuthorizedView(ctx context.Context, req *adminpb.CreateAuthorizedViewRequest, opts ...gax.CallOption) (*CreateAuthorizedViewOperation, error)

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

func (c *BigtableTableAdminClient) CreateBackup(ctx context.Context, req *adminpb.CreateBackupRequest, opts ...gax.CallOption) (*CreateBackupOperation, error)

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

func (c *BigtableTableAdminClient) CreateSchemaBundle(ctx context.Context, req *adminpb.CreateSchemaBundleRequest, opts ...gax.CallOption) (*CreateSchemaBundleOperation, error)

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

func (c *BigtableTableAdminClient) CreateTable(ctx context.Context, req *adminpb.CreateTableRequest, opts ...gax.CallOption) (*adminpb.Table, error)

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

func (c *BigtableTableAdminClient) CreateTableFromSnapshot(ctx context.Context, req *adminpb.CreateTableFromSnapshotRequest, opts ...gax.CallOption) (*CreateTableFromSnapshotOperation, error)

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

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

DeleteBackup deletes a pending or completed Cloud Bigtable backup.

func (*BigtableTableAdminClient) DeleteSchemaBundle

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

DeleteSchemaBundle deletes a schema bundle in the specified table.

func (*BigtableTableAdminClient) DeleteSnapshot

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

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

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

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

func (*BigtableTableAdminClient) DropRowRange

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

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

func (c *BigtableTableAdminClient) GenerateConsistencyToken(ctx context.Context, req *adminpb.GenerateConsistencyTokenRequest, opts ...gax.CallOption) (*adminpb.GenerateConsistencyTokenResponse, error)

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

func (c *BigtableTableAdminClient) GetAuthorizedView(ctx context.Context, req *adminpb.GetAuthorizedViewRequest, opts ...gax.CallOption) (*adminpb.AuthorizedView, error)

GetAuthorizedView gets information from a specified AuthorizedView.

func (*BigtableTableAdminClient) GetBackup

func (c *BigtableTableAdminClient) GetBackup(ctx context.Context, req *adminpb.GetBackupRequest, opts ...gax.CallOption) (*adminpb.Backup, error)

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

func (*BigtableTableAdminClient) GetIamPolicy

func (c *BigtableTableAdminClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

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

func (c *BigtableTableAdminClient) GetSchemaBundle(ctx context.Context, req *adminpb.GetSchemaBundleRequest, opts ...gax.CallOption) (*adminpb.SchemaBundle, error)

GetSchemaBundle gets metadata information about the specified schema bundle.

func (*BigtableTableAdminClient) GetSnapshot

func (c *BigtableTableAdminClient) GetSnapshot(ctx context.Context, req *adminpb.GetSnapshotRequest, opts ...gax.CallOption) (*adminpb.Snapshot, error)

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

func (c *BigtableTableAdminClient) GetTable(ctx context.Context, req *adminpb.GetTableRequest, opts ...gax.CallOption) (*adminpb.Table, error)

GetTable gets metadata information about the specified table.

func (*BigtableTableAdminClient) ListAuthorizedViews

func (c *BigtableTableAdminClient) ListAuthorizedViews(ctx context.Context, req *adminpb.ListAuthorizedViewsRequest, opts ...gax.CallOption) *AuthorizedViewIterator

ListAuthorizedViews lists all AuthorizedViews from a specific table.

func (*BigtableTableAdminClient) ListBackups

func (c *BigtableTableAdminClient) ListBackups(ctx context.Context, req *adminpb.ListBackupsRequest, opts ...gax.CallOption) *BackupIterator

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

func (*BigtableTableAdminClient) ListSchemaBundles

func (c *BigtableTableAdminClient) ListSchemaBundles(ctx context.Context, req *adminpb.ListSchemaBundlesRequest, opts ...gax.CallOption) *SchemaBundleIterator

ListSchemaBundles lists all schema bundles associated with the specified table.

func (*BigtableTableAdminClient) ListSnapshots

func (c *BigtableTableAdminClient) ListSnapshots(ctx context.Context, req *adminpb.ListSnapshotsRequest, opts ...gax.CallOption) *SnapshotIterator

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

func (c *BigtableTableAdminClient) ListTables(ctx context.Context, req *adminpb.ListTablesRequest, opts ...gax.CallOption) *TableIterator

ListTables lists all tables served from a specified instance.

func (*BigtableTableAdminClient) ModifyColumnFamilies

func (c *BigtableTableAdminClient) ModifyColumnFamilies(ctx context.Context, req *adminpb.ModifyColumnFamiliesRequest, opts ...gax.CallOption) (*adminpb.Table, error)

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

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

RestoreTable creates a new table by restoring from a backup.

func (*BigtableTableAdminClient) SetIamPolicy

func (c *BigtableTableAdminClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

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

func (*BigtableTableAdminClient) SnapshotTable

func (c *BigtableTableAdminClient) SnapshotTable(ctx context.Context, req *adminpb.SnapshotTableRequest, opts ...gax.CallOption) (*SnapshotTableOperation, error)

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

func (c *BigtableTableAdminClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)

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

func (*BigtableTableAdminClient) UndeleteTable

func (c *BigtableTableAdminClient) UndeleteTable(ctx context.Context, req *adminpb.UndeleteTableRequest, opts ...gax.CallOption) (*UndeleteTableOperation, error)

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

func (c *BigtableTableAdminClient) UpdateAuthorizedView(ctx context.Context, req *adminpb.UpdateAuthorizedViewRequest, opts ...gax.CallOption) (*UpdateAuthorizedViewOperation, error)

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

func (c *BigtableTableAdminClient) UpdateBackup(ctx context.Context, req *adminpb.UpdateBackupRequest, opts ...gax.CallOption) (*adminpb.Backup, error)

UpdateBackup updates a pending or completed Cloud Bigtable Backup.

func (*BigtableTableAdminClient) UpdateSchemaBundle

func (c *BigtableTableAdminClient) UpdateSchemaBundle(ctx context.Context, req *adminpb.UpdateSchemaBundleRequest, opts ...gax.CallOption) (*UpdateSchemaBundleOperation, error)

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

func (c *BigtableTableAdminClient) UpdateTable(ctx context.Context, req *adminpb.UpdateTableRequest, opts ...gax.CallOption) (*UpdateTableOperation, error)

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.

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

func (op *CopyBackupOperation) Metadata() (*adminpb.CopyBackupMetadata, error)

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

func (*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.

CreateAuthorizedViewOperation

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

CreateAuthorizedViewOperation manages a long-running operation from CreateAuthorizedView.

func (*CreateAuthorizedViewOperation) Done

func (op *CreateAuthorizedViewOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateAuthorizedViewOperation) Metadata

func (op *CreateAuthorizedViewOperation) Metadata() (*adminpb.CreateAuthorizedViewMetadata, error)

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

func (*CreateAuthorizedViewOperation) Name

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

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

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

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

func (op *CreateBackupOperation) Metadata() (*adminpb.CreateBackupMetadata, error)

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

func (*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

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

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

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

func (op *CreateClusterOperation) Metadata() (*adminpb.CreateClusterMetadata, error)

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

func (*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

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

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

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

func (op *CreateInstanceOperation) Metadata() (*adminpb.CreateInstanceMetadata, error)

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

func (*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

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

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

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

func (op *CreateLogicalViewOperation) Metadata() (*adminpb.CreateLogicalViewMetadata, error)

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

func (*CreateLogicalViewOperation) Name

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

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

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

CreateMaterializedViewOperation

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

CreateMaterializedViewOperation manages a long-running operation from CreateMaterializedView.

func (*CreateMaterializedViewOperation) Done

func (op *CreateMaterializedViewOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateMaterializedViewOperation) Metadata

func (op *CreateMaterializedViewOperation) Metadata() (*adminpb.CreateMaterializedViewMetadata, error)

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

func (*CreateMaterializedViewOperation) Name

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

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

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

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

func (op *CreateSchemaBundleOperation) Metadata() (*adminpb.CreateSchemaBundleMetadata, error)

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

func (*CreateSchemaBundleOperation) Name

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

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

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

CreateTableFromSnapshotOperation

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

CreateTableFromSnapshotOperation manages a long-running operation from CreateTableFromSnapshot.

func (*CreateTableFromSnapshotOperation) Done

func (op *CreateTableFromSnapshotOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateTableFromSnapshotOperation) Metadata

func (op *CreateTableFromSnapshotOperation) Metadata() (*adminpb.CreateTableFromSnapshotMetadata, error)

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

func (*CreateTableFromSnapshotOperation) Name

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

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

func (op *CreateTableFromSnapshotOperation) 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.

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

func (it *HotTabletIterator) All() iter.Seq2[*adminpb.HotTablet, error]

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.

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

func (it *LogicalViewIterator) All() iter.Seq2[*adminpb.LogicalView, error]

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

func (*LogicalViewIterator) Next

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

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

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

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

func (it *MaterializedViewIterator) All() iter.Seq2[*adminpb.MaterializedView, error]

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

func (*MaterializedViewIterator) Next

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

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

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

PartialUpdateClusterOperation

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

PartialUpdateClusterOperation manages a long-running operation from PartialUpdateCluster.

func (*PartialUpdateClusterOperation) Done

func (op *PartialUpdateClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*PartialUpdateClusterOperation) Metadata

func (op *PartialUpdateClusterOperation) Metadata() (*adminpb.PartialUpdateClusterMetadata, error)

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

func (*PartialUpdateClusterOperation) Name

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

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

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

PartialUpdateInstanceOperation

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

PartialUpdateInstanceOperation manages a long-running operation from PartialUpdateInstance.

func (*PartialUpdateInstanceOperation) Done

func (op *PartialUpdateInstanceOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*PartialUpdateInstanceOperation) Metadata

func (op *PartialUpdateInstanceOperation) Metadata() (*adminpb.UpdateInstanceMetadata, error)

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

func (*PartialUpdateInstanceOperation) Name

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

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

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

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

func (op *RestoreTableOperation) Metadata() (*adminpb.RestoreTableMetadata, error)

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

func (*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

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

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

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

func (it *SchemaBundleIterator) All() iter.Seq2[*adminpb.SchemaBundle, error]

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

func (*SchemaBundleIterator) Next

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

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

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

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

func (it *SnapshotIterator) All() iter.Seq2[*adminpb.Snapshot, error]

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.

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

func (op *SnapshotTableOperation) Metadata() (*adminpb.SnapshotTableMetadata, error)

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

func (*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

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

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

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.

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

func (op *UndeleteTableOperation) Metadata() (*adminpb.UndeleteTableMetadata, error)

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

func (*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

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

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

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

func (op *UpdateAppProfileOperation) Metadata() (*adminpb.UpdateAppProfileMetadata, error)

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

func (*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

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

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

UpdateAuthorizedViewOperation

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

UpdateAuthorizedViewOperation manages a long-running operation from UpdateAuthorizedView.

func (*UpdateAuthorizedViewOperation) Done

func (op *UpdateAuthorizedViewOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateAuthorizedViewOperation) Metadata

func (op *UpdateAuthorizedViewOperation) Metadata() (*adminpb.UpdateAuthorizedViewMetadata, error)

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

func (*UpdateAuthorizedViewOperation) Name

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

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

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

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

func (op *UpdateClusterOperation) Metadata() (*adminpb.UpdateClusterMetadata, error)

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

func (*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

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

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

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

func (op *UpdateLogicalViewOperation) Metadata() (*adminpb.UpdateLogicalViewMetadata, error)

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

func (*UpdateLogicalViewOperation) Name

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

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

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

UpdateMaterializedViewOperation

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

UpdateMaterializedViewOperation manages a long-running operation from UpdateMaterializedView.

func (*UpdateMaterializedViewOperation) Done

func (op *UpdateMaterializedViewOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateMaterializedViewOperation) Metadata

func (op *UpdateMaterializedViewOperation) Metadata() (*adminpb.UpdateMaterializedViewMetadata, error)

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

func (*UpdateMaterializedViewOperation) Name

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

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

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

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

func (op *UpdateSchemaBundleOperation) Metadata() (*adminpb.UpdateSchemaBundleMetadata, error)

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

func (*UpdateSchemaBundleOperation) Name

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

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

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

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

func (op *UpdateTableOperation) Metadata() (*adminpb.UpdateTableMetadata, error)

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

func (*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.