google_bigtable_admin_cluster_v1

package
v2.3.1+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 23, 2016 License: Apache-2.0, Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package google_bigtable_admin_cluster_v1 is a generated protocol buffer package.

It is generated from these files: 

google.golang.org/cloud/bigtable/internal/cluster_service_proto/bigtable_cluster_service_messages.proto
google.golang.org/cloud/bigtable/internal/cluster_service_proto/bigtable_cluster_service.proto

It has these top-level messages: 

ListZonesRequest
ListZonesResponse
GetClusterRequest
ListClustersRequest
ListClustersResponse
CreateClusterRequest
CreateClusterMetadata
UpdateClusterMetadata
DeleteClusterRequest
UndeleteClusterRequest
UndeleteClusterMetadata

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterBigtableClusterServiceServer 

func RegisterBigtableClusterServiceServer(s *grpc.Server, srv BigtableClusterServiceServer)

Types

type BigtableClusterServiceClient 

type BigtableClusterServiceClient interface {
	// Lists the supported zones for the given project.
	ListZones(ctx context.Context, in *ListZonesRequest, opts ...grpc.CallOption) (*ListZonesResponse, error)
	// Gets information about a particular cluster.
	GetCluster(ctx context.Context, in *GetClusterRequest, opts ...grpc.CallOption) (*google_bigtable_admin_cluster_v11.Cluster, error)
	// Lists all clusters in the given project, along with any zones for which
	// cluster information could not be retrieved.
	ListClusters(ctx context.Context, in *ListClustersRequest, opts ...grpc.CallOption) (*ListClustersResponse, error)
	// Creates a cluster and begins preparing it to begin serving. The returned
	// cluster embeds as its "current_operation" a long-running operation which
	// can be used to track the progress of turning up the new cluster.
	// Immediately upon completion of this request:
	//  * The cluster will be readable via the API, with all requested attributes
	//    but no allocated resources.
	// Until completion of the embedded operation:
	//  * Cancelling the operation will render the cluster immediately unreadable
	//    via the API.
	//  * All other attempts to modify or delete the cluster will be rejected.
	// Upon completion of the embedded operation:
	//  * Billing for all successfully-allocated resources will begin (some types
	//    may have lower than the requested levels).
	//  * New tables can be created in the cluster.
	//  * The cluster's allocated resource levels will be readable via the API.
	// The embedded operation's "metadata" field type is
	// [CreateClusterMetadata][google.bigtable.admin.cluster.v1.CreateClusterMetadata] The embedded operation's "response" field type is
	// [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
	CreateCluster(ctx context.Context, in *CreateClusterRequest, opts ...grpc.CallOption) (*google_bigtable_admin_cluster_v11.Cluster, error)
	// Updates a cluster, and begins allocating or releasing resources as
	// requested. The returned cluster embeds as its "current_operation" a
	// long-running operation which can be used to track the progress of updating
	// the cluster.
	// Immediately upon completion of this request:
	//  * For resource types where a decrease in the cluster's allocation has been
	//    requested, billing will be based on the newly-requested level.
	// Until completion of the embedded operation:
	//  * Cancelling the operation will set its metadata's "cancelled_at_time",
	//    and begin restoring resources to their pre-request values. The operation
	//    is guaranteed to succeed at undoing all resource changes, after which
	//    point it will terminate with a CANCELLED status.
	//  * All other attempts to modify or delete the cluster will be rejected.
	//  * Reading the cluster via the API will continue to give the pre-request
	//    resource levels.
	// Upon completion of the embedded operation:
	//  * Billing will begin for all successfully-allocated resources (some types
	//    may have lower than the requested levels).
	//  * All newly-reserved resources will be available for serving the cluster's
	//    tables.
	//  * The cluster's new resource levels will be readable via the API.
	// [UpdateClusterMetadata][google.bigtable.admin.cluster.v1.UpdateClusterMetadata] The embedded operation's "response" field type is
	// [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
	UpdateCluster(ctx context.Context, in *google_bigtable_admin_cluster_v11.Cluster, opts ...grpc.CallOption) (*google_bigtable_admin_cluster_v11.Cluster, error)
	// Marks a cluster and all of its tables for permanent deletion in 7 days.
	// Immediately upon completion of the request:
	//  * Billing will cease for all of the cluster's reserved resources.
	//  * The cluster's "delete_time" field will be set 7 days in the future.
	// Soon afterward:
	//  * All tables within the cluster will become unavailable.
	// Prior to the cluster's "delete_time":
	//  * The cluster can be recovered with a call to UndeleteCluster.
	//  * All other attempts to modify or delete the cluster will be rejected.
	// At the cluster's "delete_time":
	//  * The cluster and *all of its tables* will immediately and irrevocably
	//    disappear from the API, and their data will be permanently deleted.
	DeleteCluster(ctx context.Context, in *DeleteClusterRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
}

func NewBigtableClusterServiceClient 

func NewBigtableClusterServiceClient(cc *grpc.ClientConn) BigtableClusterServiceClient

type BigtableClusterServiceServer 

type BigtableClusterServiceServer interface {
	// Lists the supported zones for the given project.
	ListZones(context.Context, *ListZonesRequest) (*ListZonesResponse, error)
	// Gets information about a particular cluster.
	GetCluster(context.Context, *GetClusterRequest) (*google_bigtable_admin_cluster_v11.Cluster, error)
	// Lists all clusters in the given project, along with any zones for which
	// cluster information could not be retrieved.
	ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
	// Creates a cluster and begins preparing it to begin serving. The returned
	// cluster embeds as its "current_operation" a long-running operation which
	// can be used to track the progress of turning up the new cluster.
	// Immediately upon completion of this request:
	//  * The cluster will be readable via the API, with all requested attributes
	//    but no allocated resources.
	// Until completion of the embedded operation:
	//  * Cancelling the operation will render the cluster immediately unreadable
	//    via the API.
	//  * All other attempts to modify or delete the cluster will be rejected.
	// Upon completion of the embedded operation:
	//  * Billing for all successfully-allocated resources will begin (some types
	//    may have lower than the requested levels).
	//  * New tables can be created in the cluster.
	//  * The cluster's allocated resource levels will be readable via the API.
	// The embedded operation's "metadata" field type is
	// [CreateClusterMetadata][google.bigtable.admin.cluster.v1.CreateClusterMetadata] The embedded operation's "response" field type is
	// [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
	CreateCluster(context.Context, *CreateClusterRequest) (*google_bigtable_admin_cluster_v11.Cluster, error)
	// Updates a cluster, and begins allocating or releasing resources as
	// requested. The returned cluster embeds as its "current_operation" a
	// long-running operation which can be used to track the progress of updating
	// the cluster.
	// Immediately upon completion of this request:
	//  * For resource types where a decrease in the cluster's allocation has been
	//    requested, billing will be based on the newly-requested level.
	// Until completion of the embedded operation:
	//  * Cancelling the operation will set its metadata's "cancelled_at_time",
	//    and begin restoring resources to their pre-request values. The operation
	//    is guaranteed to succeed at undoing all resource changes, after which
	//    point it will terminate with a CANCELLED status.
	//  * All other attempts to modify or delete the cluster will be rejected.
	//  * Reading the cluster via the API will continue to give the pre-request
	//    resource levels.
	// Upon completion of the embedded operation:
	//  * Billing will begin for all successfully-allocated resources (some types
	//    may have lower than the requested levels).
	//  * All newly-reserved resources will be available for serving the cluster's
	//    tables.
	//  * The cluster's new resource levels will be readable via the API.
	// [UpdateClusterMetadata][google.bigtable.admin.cluster.v1.UpdateClusterMetadata] The embedded operation's "response" field type is
	// [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
	UpdateCluster(context.Context, *google_bigtable_admin_cluster_v11.Cluster) (*google_bigtable_admin_cluster_v11.Cluster, error)
	// Marks a cluster and all of its tables for permanent deletion in 7 days.
	// Immediately upon completion of the request:
	//  * Billing will cease for all of the cluster's reserved resources.
	//  * The cluster's "delete_time" field will be set 7 days in the future.
	// Soon afterward:
	//  * All tables within the cluster will become unavailable.
	// Prior to the cluster's "delete_time":
	//  * The cluster can be recovered with a call to UndeleteCluster.
	//  * All other attempts to modify or delete the cluster will be rejected.
	// At the cluster's "delete_time":
	//  * The cluster and *all of its tables* will immediately and irrevocably
	//    disappear from the API, and their data will be permanently deleted.
	DeleteCluster(context.Context, *DeleteClusterRequest) (*google_protobuf.Empty, error)
}

type CreateClusterMetadata 

type CreateClusterMetadata struct {
	// The request which prompted the creation of this operation.
	OriginalRequest *CreateClusterRequest `protobuf:"bytes,1,opt,name=original_request" json:"original_request,omitempty"`
}

Metadata type for the operation returned by BigtableClusterService.CreateCluster.

func (*CreateClusterMetadata) GetOriginalRequest 

func (m *CreateClusterMetadata) GetOriginalRequest() *CreateClusterRequest

func (*CreateClusterMetadata) ProtoMessage 

func (*CreateClusterMetadata) ProtoMessage()

func (*CreateClusterMetadata) Reset 

func (m *CreateClusterMetadata) Reset()

func (*CreateClusterMetadata) String 

func (m *CreateClusterMetadata) String() string

type CreateClusterRequest 

type CreateClusterRequest struct {
	// The unique name of the zone in which to create the cluster.
	// Values are of the form projects/<project>/zones/<zone>
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The id to be used when referring to the new cluster within its zone,
	// e.g. just the "test-cluster" section of the full name
	// "projects/<project>/zones/<zone>/clusters/test-cluster".
	ClusterId string `protobuf:"bytes,2,opt,name=cluster_id" json:"cluster_id,omitempty"`
	// The cluster to create.
	// The "name", "delete_time", and "current_operation" fields must be left
	// blank.
	Cluster *google_bigtable_admin_cluster_v11.Cluster `protobuf:"bytes,3,opt,name=cluster" json:"cluster,omitempty"`
}

Request message for BigtableClusterService.CreateCluster.

func (*CreateClusterRequest) GetCluster 

func (m *CreateClusterRequest) GetCluster() *google_bigtable_admin_cluster_v11.Cluster

func (*CreateClusterRequest) ProtoMessage 

func (*CreateClusterRequest) ProtoMessage()

func (*CreateClusterRequest) Reset 

func (m *CreateClusterRequest) Reset()

func (*CreateClusterRequest) String 

func (m *CreateClusterRequest) String() string

type DeleteClusterRequest 

type DeleteClusterRequest struct {
	// The unique name of the cluster to be deleted.
	// Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request message for BigtableClusterService.DeleteCluster.

func (*DeleteClusterRequest) ProtoMessage 

func (*DeleteClusterRequest) ProtoMessage()

func (*DeleteClusterRequest) Reset 

func (m *DeleteClusterRequest) Reset()

func (*DeleteClusterRequest) String 

func (m *DeleteClusterRequest) String() string

type GetClusterRequest 

type GetClusterRequest struct {
	// The unique name of the requested cluster.
	// Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request message for BigtableClusterService.GetCluster.

func (*GetClusterRequest) ProtoMessage 

func (*GetClusterRequest) ProtoMessage()

func (*GetClusterRequest) Reset 

func (m *GetClusterRequest) Reset()

func (*GetClusterRequest) String 

func (m *GetClusterRequest) String() string

type ListClustersRequest 

type ListClustersRequest struct {
	// The unique name of the project for which a list of clusters is requested.
	// Values are of the form projects/<project>
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request message for BigtableClusterService.ListClusters.

func (*ListClustersRequest) ProtoMessage 

func (*ListClustersRequest) ProtoMessage()

func (*ListClustersRequest) Reset 

func (m *ListClustersRequest) Reset()

func (*ListClustersRequest) String 

func (m *ListClustersRequest) String() string

type ListClustersResponse 

type ListClustersResponse struct {
	// The list of requested Clusters.
	Clusters []*google_bigtable_admin_cluster_v11.Cluster `protobuf:"bytes,1,rep,name=clusters" json:"clusters,omitempty"`
	// The zones for which clusters could not be retrieved.
	FailedZones []*google_bigtable_admin_cluster_v11.Zone `protobuf:"bytes,2,rep,name=failed_zones" json:"failed_zones,omitempty"`
}

Response message for BigtableClusterService.ListClusters.

func (*ListClustersResponse) GetClusters 

func (m *ListClustersResponse) GetClusters() []*google_bigtable_admin_cluster_v11.Cluster

func (*ListClustersResponse) GetFailedZones 

func (m *ListClustersResponse) GetFailedZones() []*google_bigtable_admin_cluster_v11.Zone

func (*ListClustersResponse) ProtoMessage 

func (*ListClustersResponse) ProtoMessage()

func (*ListClustersResponse) Reset 

func (m *ListClustersResponse) Reset()

func (*ListClustersResponse) String 

func (m *ListClustersResponse) String() string

type ListZonesRequest 

type ListZonesRequest struct {
	// The unique name of the project for which a list of supported zones is
	// requested.
	// Values are of the form projects/<project>
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request message for BigtableClusterService.ListZones.

func (*ListZonesRequest) ProtoMessage 

func (*ListZonesRequest) ProtoMessage()

func (*ListZonesRequest) Reset 

func (m *ListZonesRequest) Reset()

func (*ListZonesRequest) String 

func (m *ListZonesRequest) String() string

type ListZonesResponse 

type ListZonesResponse struct {
	// The list of requested zones.
	Zones []*google_bigtable_admin_cluster_v11.Zone `protobuf:"bytes,1,rep,name=zones" json:"zones,omitempty"`
}

Response message for BigtableClusterService.ListZones.

func (*ListZonesResponse) GetZones 

func (m *ListZonesResponse) GetZones() []*google_bigtable_admin_cluster_v11.Zone

func (*ListZonesResponse) ProtoMessage 

func (*ListZonesResponse) ProtoMessage()

func (*ListZonesResponse) Reset 

func (m *ListZonesResponse) Reset()

func (*ListZonesResponse) String 

func (m *ListZonesResponse) String() string

type UndeleteClusterMetadata 

type UndeleteClusterMetadata struct {
}

Metadata type for the operation returned by BigtableClusterService.UndeleteCluster.

func (*UndeleteClusterMetadata) ProtoMessage 

func (*UndeleteClusterMetadata) ProtoMessage()

func (*UndeleteClusterMetadata) Reset 

func (m *UndeleteClusterMetadata) Reset()

func (*UndeleteClusterMetadata) String 

func (m *UndeleteClusterMetadata) String() string

type UndeleteClusterRequest 

type UndeleteClusterRequest struct {
	// The unique name of the cluster to be un-deleted.
	// Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

Request message for BigtableClusterService.UndeleteCluster.

func (*UndeleteClusterRequest) ProtoMessage 

func (*UndeleteClusterRequest) ProtoMessage()

func (*UndeleteClusterRequest) Reset 

func (m *UndeleteClusterRequest) Reset()

func (*UndeleteClusterRequest) String 

func (m *UndeleteClusterRequest) String() string

type UpdateClusterMetadata 

type UpdateClusterMetadata struct {
	// The request which prompted the creation of this operation.
	OriginalRequest *google_bigtable_admin_cluster_v11.Cluster `protobuf:"bytes,1,opt,name=original_request" json:"original_request,omitempty"`
}

Metadata type for the operation returned by BigtableClusterService.UpdateCluster.

func (*UpdateClusterMetadata) GetOriginalRequest 

func (m *UpdateClusterMetadata) GetOriginalRequest() *google_bigtable_admin_cluster_v11.Cluster

func (*UpdateClusterMetadata) ProtoMessage 

func (*UpdateClusterMetadata) ProtoMessage()

func (*UpdateClusterMetadata) Reset 

func (m *UpdateClusterMetadata) Reset()

func (*UpdateClusterMetadata) String 

func (m *UpdateClusterMetadata) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.