...

Package cluster

import "google.golang.org/genproto/googleapis/bigtable/admin/cluster/v1"
Overview
Index

Overview ▾

Index ▾

Variables
func RegisterBigtableClusterServiceServer(s *grpc.Server, srv BigtableClusterServiceServer)
type BigtableClusterServiceClient
    func NewBigtableClusterServiceClient(cc grpc.ClientConnInterface) BigtableClusterServiceClient
type BigtableClusterServiceServer
type Cluster
    func (*Cluster) Descriptor() ([]byte, []int)
    func (x *Cluster) GetCurrentOperation() *longrunning.Operation
    func (x *Cluster) GetDefaultStorageType() StorageType
    func (x *Cluster) GetDisplayName() string
    func (x *Cluster) GetName() string
    func (x *Cluster) GetServeNodes() int32
    func (*Cluster) ProtoMessage()
    func (x *Cluster) ProtoReflect() protoreflect.Message
    func (x *Cluster) Reset()
    func (x *Cluster) String() string
type CreateClusterMetadata
    func (*CreateClusterMetadata) Descriptor() ([]byte, []int)
    func (x *CreateClusterMetadata) GetFinishTime() *timestamppb.Timestamp
    func (x *CreateClusterMetadata) GetOriginalRequest() *CreateClusterRequest
    func (x *CreateClusterMetadata) GetRequestTime() *timestamppb.Timestamp
    func (*CreateClusterMetadata) ProtoMessage()
    func (x *CreateClusterMetadata) ProtoReflect() protoreflect.Message
    func (x *CreateClusterMetadata) Reset()
    func (x *CreateClusterMetadata) String() string
type CreateClusterRequest
    func (*CreateClusterRequest) Descriptor() ([]byte, []int)
    func (x *CreateClusterRequest) GetCluster() *Cluster
    func (x *CreateClusterRequest) GetClusterId() string
    func (x *CreateClusterRequest) GetName() string
    func (*CreateClusterRequest) ProtoMessage()
    func (x *CreateClusterRequest) ProtoReflect() protoreflect.Message
    func (x *CreateClusterRequest) Reset()
    func (x *CreateClusterRequest) String() string
type DeleteClusterRequest
    func (*DeleteClusterRequest) Descriptor() ([]byte, []int)
    func (x *DeleteClusterRequest) GetName() string
    func (*DeleteClusterRequest) ProtoMessage()
    func (x *DeleteClusterRequest) ProtoReflect() protoreflect.Message
    func (x *DeleteClusterRequest) Reset()
    func (x *DeleteClusterRequest) String() string
type GetClusterRequest
    func (*GetClusterRequest) Descriptor() ([]byte, []int)
    func (x *GetClusterRequest) GetName() string
    func (*GetClusterRequest) ProtoMessage()
    func (x *GetClusterRequest) ProtoReflect() protoreflect.Message
    func (x *GetClusterRequest) Reset()
    func (x *GetClusterRequest) String() string
type ListClustersRequest
    func (*ListClustersRequest) Descriptor() ([]byte, []int)
    func (x *ListClustersRequest) GetName() string
    func (*ListClustersRequest) ProtoMessage()
    func (x *ListClustersRequest) ProtoReflect() protoreflect.Message
    func (x *ListClustersRequest) Reset()
    func (x *ListClustersRequest) String() string
type ListClustersResponse
    func (*ListClustersResponse) Descriptor() ([]byte, []int)
    func (x *ListClustersResponse) GetClusters() []*Cluster
    func (x *ListClustersResponse) GetFailedZones() []*Zone
    func (*ListClustersResponse) ProtoMessage()
    func (x *ListClustersResponse) ProtoReflect() protoreflect.Message
    func (x *ListClustersResponse) Reset()
    func (x *ListClustersResponse) String() string
type ListZonesRequest
    func (*ListZonesRequest) Descriptor() ([]byte, []int)
    func (x *ListZonesRequest) GetName() string
    func (*ListZonesRequest) ProtoMessage()
    func (x *ListZonesRequest) ProtoReflect() protoreflect.Message
    func (x *ListZonesRequest) Reset()
    func (x *ListZonesRequest) String() string
type ListZonesResponse
    func (*ListZonesResponse) Descriptor() ([]byte, []int)
    func (x *ListZonesResponse) GetZones() []*Zone
    func (*ListZonesResponse) ProtoMessage()
    func (x *ListZonesResponse) ProtoReflect() protoreflect.Message
    func (x *ListZonesResponse) Reset()
    func (x *ListZonesResponse) String() string
type StorageType
    func (StorageType) Descriptor() protoreflect.EnumDescriptor
    func (x StorageType) Enum() *StorageType
    func (StorageType) EnumDescriptor() ([]byte, []int)
    func (x StorageType) Number() protoreflect.EnumNumber
    func (x StorageType) String() string
    func (StorageType) Type() protoreflect.EnumType
type UndeleteClusterMetadata
    func (*UndeleteClusterMetadata) Descriptor() ([]byte, []int)
    func (x *UndeleteClusterMetadata) GetFinishTime() *timestamppb.Timestamp
    func (x *UndeleteClusterMetadata) GetRequestTime() *timestamppb.Timestamp
    func (*UndeleteClusterMetadata) ProtoMessage()
    func (x *UndeleteClusterMetadata) ProtoReflect() protoreflect.Message
    func (x *UndeleteClusterMetadata) Reset()
    func (x *UndeleteClusterMetadata) String() string
type UndeleteClusterRequest
    func (*UndeleteClusterRequest) Descriptor() ([]byte, []int)
    func (x *UndeleteClusterRequest) GetName() string
    func (*UndeleteClusterRequest) ProtoMessage()
    func (x *UndeleteClusterRequest) ProtoReflect() protoreflect.Message
    func (x *UndeleteClusterRequest) Reset()
    func (x *UndeleteClusterRequest) String() string
type UnimplementedBigtableClusterServiceServer
    func (*UnimplementedBigtableClusterServiceServer) CreateCluster(context.Context, *CreateClusterRequest) (*Cluster, error)
    func (*UnimplementedBigtableClusterServiceServer) DeleteCluster(context.Context, *DeleteClusterRequest) (*emptypb.Empty, error)
    func (*UnimplementedBigtableClusterServiceServer) GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)
    func (*UnimplementedBigtableClusterServiceServer) ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
    func (*UnimplementedBigtableClusterServiceServer) ListZones(context.Context, *ListZonesRequest) (*ListZonesResponse, error)
    func (*UnimplementedBigtableClusterServiceServer) UndeleteCluster(context.Context, *UndeleteClusterRequest) (*longrunning.Operation, error)
    func (*UnimplementedBigtableClusterServiceServer) UpdateCluster(context.Context, *Cluster) (*Cluster, error)
type UpdateClusterMetadata
    func (*UpdateClusterMetadata) Descriptor() ([]byte, []int)
    func (x *UpdateClusterMetadata) GetCancelTime() *timestamppb.Timestamp
    func (x *UpdateClusterMetadata) GetFinishTime() *timestamppb.Timestamp
    func (x *UpdateClusterMetadata) GetOriginalRequest() *Cluster
    func (x *UpdateClusterMetadata) GetRequestTime() *timestamppb.Timestamp
    func (*UpdateClusterMetadata) ProtoMessage()
    func (x *UpdateClusterMetadata) ProtoReflect() protoreflect.Message
    func (x *UpdateClusterMetadata) Reset()
    func (x *UpdateClusterMetadata) String() string
type V2OperationMetadata
    func (*V2OperationMetadata) Descriptor() ([]byte, []int)
    func (*V2OperationMetadata) ProtoMessage()
    func (x *V2OperationMetadata) ProtoReflect() protoreflect.Message
    func (x *V2OperationMetadata) Reset()
    func (x *V2OperationMetadata) String() string
type Zone
    func (*Zone) Descriptor() ([]byte, []int)
    func (x *Zone) GetDisplayName() string
    func (x *Zone) GetName() string
    func (x *Zone) GetStatus() Zone_Status
    func (*Zone) ProtoMessage()
    func (x *Zone) ProtoReflect() protoreflect.Message
    func (x *Zone) Reset()
    func (x *Zone) String() string
type Zone_Status
    func (Zone_Status) Descriptor() protoreflect.EnumDescriptor
    func (x Zone_Status) Enum() *Zone_Status
    func (Zone_Status) EnumDescriptor() ([]byte, []int)
    func (x Zone_Status) Number() protoreflect.EnumNumber
    func (x Zone_Status) String() string
    func (Zone_Status) Type() protoreflect.EnumType

Package files

bigtable_cluster_data.pb.go bigtable_cluster_service.pb.go bigtable_cluster_service_messages.pb.go

Variables

Enum value maps for StorageType.

var (
    StorageType_name = map[int32]string{
        0: "STORAGE_UNSPECIFIED",
        1: "STORAGE_SSD",
        2: "STORAGE_HDD",
    }
    StorageType_value = map[string]int32{
        "STORAGE_UNSPECIFIED": 0,
        "STORAGE_SSD":         1,
        "STORAGE_HDD":         2,
    }
)

Enum value maps for Zone_Status.

var (
    Zone_Status_name = map[int32]string{
        0: "UNKNOWN",
        1: "OK",
        2: "PLANNED_MAINTENANCE",
        3: "EMERGENCY_MAINENANCE",
    }
    Zone_Status_value = map[string]int32{
        "UNKNOWN":              0,
        "OK":                   1,
        "PLANNED_MAINTENANCE":  2,
        "EMERGENCY_MAINENANCE": 3,
    }
)
var File_google_bigtable_admin_cluster_v1_bigtable_cluster_data_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_cluster_v1_bigtable_cluster_service_messages_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_cluster_v1_bigtable_cluster_service_proto protoreflect.FileDescriptor

func RegisterBigtableClusterServiceServer

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

type BigtableClusterServiceClient

BigtableClusterServiceClient is the client API for BigtableClusterService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

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) (*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) (*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 *Cluster, opts ...grpc.CallOption) (*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) (*emptypb.Empty, error)
    // Cancels the scheduled deletion of an cluster and begins preparing it to
    // resume serving. The returned operation will also be embedded as the
    // cluster's "current_operation".
    // Immediately upon completion of this request:
    //  * The cluster's "delete_time" field will be unset, protecting it from
    //    automatic deletion.
    // Until completion of the returned operation:
    //  * The operation cannot be cancelled.
    // Upon completion of the returned operation:
    //  * Billing for the cluster's resources will resume.
    //  * All tables within the cluster will be available.
    // [UndeleteClusterMetadata][google.bigtable.admin.cluster.v1.UndeleteClusterMetadata]
    // The embedded operation's "response" field type is
    // [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
    UndeleteCluster(ctx context.Context, in *UndeleteClusterRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

func NewBigtableClusterServiceClient

func NewBigtableClusterServiceClient(cc grpc.ClientConnInterface) BigtableClusterServiceClient

type BigtableClusterServiceServer

BigtableClusterServiceServer is the server API for BigtableClusterService service.

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) (*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) (*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, *Cluster) (*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) (*emptypb.Empty, error)
    // Cancels the scheduled deletion of an cluster and begins preparing it to
    // resume serving. The returned operation will also be embedded as the
    // cluster's "current_operation".
    // Immediately upon completion of this request:
    //  * The cluster's "delete_time" field will be unset, protecting it from
    //    automatic deletion.
    // Until completion of the returned operation:
    //  * The operation cannot be cancelled.
    // Upon completion of the returned operation:
    //  * Billing for the cluster's resources will resume.
    //  * All tables within the cluster will be available.
    // [UndeleteClusterMetadata][google.bigtable.admin.cluster.v1.UndeleteClusterMetadata]
    // The embedded operation's "response" field type is
    // [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
    UndeleteCluster(context.Context, *UndeleteClusterRequest) (*longrunning.Operation, error)
}

type Cluster

An isolated set of Cloud BigTable resources on which tables can be hosted.

type Cluster struct {

    // A permanent unique identifier for the cluster. For technical reasons, the
    // zone in which the cluster resides is included here.
    // Values are of the form
    // projects/<project>/zones/<zone>/clusters/[a-z][-a-z0-9]*
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The operation currently running on the cluster, if any.
    // This cannot be set directly, only through CreateCluster, UpdateCluster,
    // or UndeleteCluster. Calls to these methods will be rejected if
    // "current_operation" is already set.
    CurrentOperation *longrunning.Operation `protobuf:"bytes,3,opt,name=current_operation,json=currentOperation,proto3" json:"current_operation,omitempty"`
    // The descriptive name for this cluster as it appears in UIs.
    // Must be unique per zone.
    DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
    // The number of serve nodes allocated to this cluster.
    ServeNodes int32 `protobuf:"varint,5,opt,name=serve_nodes,json=serveNodes,proto3" json:"serve_nodes,omitempty"`
    // What storage type to use for tables in this cluster. Only configurable at
    // cluster creation time. If unspecified, STORAGE_SSD will be used.
    DefaultStorageType StorageType `protobuf:"varint,8,opt,name=default_storage_type,json=defaultStorageType,proto3,enum=google.bigtable.admin.cluster.v1.StorageType" json:"default_storage_type,omitempty"`
    // contains filtered or unexported fields
}

func (*Cluster) Descriptor

func (*Cluster) Descriptor() ([]byte, []int)

Deprecated: Use Cluster.ProtoReflect.Descriptor instead.

func (*Cluster) GetCurrentOperation

func (x *Cluster) GetCurrentOperation() *longrunning.Operation

func (*Cluster) GetDefaultStorageType

func (x *Cluster) GetDefaultStorageType() StorageType

func (*Cluster) GetDisplayName

func (x *Cluster) GetDisplayName() string

func (*Cluster) GetName

func (x *Cluster) GetName() string

func (*Cluster) GetServeNodes

func (x *Cluster) GetServeNodes() int32

func (*Cluster) ProtoMessage

func (*Cluster) ProtoMessage()

func (*Cluster) ProtoReflect

func (x *Cluster) ProtoReflect() protoreflect.Message

func (*Cluster) Reset

func (x *Cluster) Reset()

func (*Cluster) String

func (x *Cluster) String() string

type CreateClusterMetadata

Metadata type for the operation returned by BigtableClusterService.CreateCluster.

type CreateClusterMetadata struct {

    // The request which prompted the creation of this operation.
    OriginalRequest *CreateClusterRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
    // The time at which original_request was received.
    RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
    // The time at which this operation failed or was completed successfully.
    FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
    // contains filtered or unexported fields
}

func (*CreateClusterMetadata) Descriptor

func (*CreateClusterMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateClusterMetadata.ProtoReflect.Descriptor instead.

func (*CreateClusterMetadata) GetFinishTime

func (x *CreateClusterMetadata) GetFinishTime() *timestamppb.Timestamp

func (*CreateClusterMetadata) GetOriginalRequest

func (x *CreateClusterMetadata) GetOriginalRequest() *CreateClusterRequest

func (*CreateClusterMetadata) GetRequestTime

func (x *CreateClusterMetadata) GetRequestTime() *timestamppb.Timestamp

func (*CreateClusterMetadata) ProtoMessage

func (*CreateClusterMetadata) ProtoMessage()

func (*CreateClusterMetadata) ProtoReflect

func (x *CreateClusterMetadata) ProtoReflect() protoreflect.Message

func (*CreateClusterMetadata) Reset

func (x *CreateClusterMetadata) Reset()

func (*CreateClusterMetadata) String

func (x *CreateClusterMetadata) String() string

type CreateClusterRequest

Request message for BigtableClusterService.CreateCluster.

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,proto3" 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=clusterId,proto3" json:"cluster_id,omitempty"`
    // The cluster to create.
    // The "name", "delete_time", and "current_operation" fields must be left
    // blank.
    Cluster *Cluster `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"`
    // contains filtered or unexported fields
}

func (*CreateClusterRequest) Descriptor

func (*CreateClusterRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateClusterRequest.ProtoReflect.Descriptor instead.

func (*CreateClusterRequest) GetCluster

func (x *CreateClusterRequest) GetCluster() *Cluster

func (*CreateClusterRequest) GetClusterId

func (x *CreateClusterRequest) GetClusterId() string

func (*CreateClusterRequest) GetName

func (x *CreateClusterRequest) GetName() string

func (*CreateClusterRequest) ProtoMessage

func (*CreateClusterRequest) ProtoMessage()

func (*CreateClusterRequest) ProtoReflect

func (x *CreateClusterRequest) ProtoReflect() protoreflect.Message

func (*CreateClusterRequest) Reset

func (x *CreateClusterRequest) Reset()

func (*CreateClusterRequest) String

func (x *CreateClusterRequest) String() string

type DeleteClusterRequest

Request message for BigtableClusterService.DeleteCluster.

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,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

func (*DeleteClusterRequest) Descriptor

func (*DeleteClusterRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteClusterRequest.ProtoReflect.Descriptor instead.

func (*DeleteClusterRequest) GetName

func (x *DeleteClusterRequest) GetName() string

func (*DeleteClusterRequest) ProtoMessage

func (*DeleteClusterRequest) ProtoMessage()

func (*DeleteClusterRequest) ProtoReflect

func (x *DeleteClusterRequest) ProtoReflect() protoreflect.Message

func (*DeleteClusterRequest) Reset

func (x *DeleteClusterRequest) Reset()

func (*DeleteClusterRequest) String

func (x *DeleteClusterRequest) String() string

type GetClusterRequest

Request message for BigtableClusterService.GetCluster.

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,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

func (*GetClusterRequest) Descriptor

func (*GetClusterRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetClusterRequest.ProtoReflect.Descriptor instead.

func (*GetClusterRequest) GetName

func (x *GetClusterRequest) GetName() string

func (*GetClusterRequest) ProtoMessage

func (*GetClusterRequest) ProtoMessage()

func (*GetClusterRequest) ProtoReflect

func (x *GetClusterRequest) ProtoReflect() protoreflect.Message

func (*GetClusterRequest) Reset

func (x *GetClusterRequest) Reset()

func (*GetClusterRequest) String

func (x *GetClusterRequest) String() string

type ListClustersRequest

Request message for BigtableClusterService.ListClusters.

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,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

func (*ListClustersRequest) Descriptor

func (*ListClustersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListClustersRequest.ProtoReflect.Descriptor instead.

func (*ListClustersRequest) GetName

func (x *ListClustersRequest) GetName() string

func (*ListClustersRequest) ProtoMessage

func (*ListClustersRequest) ProtoMessage()

func (*ListClustersRequest) ProtoReflect

func (x *ListClustersRequest) ProtoReflect() protoreflect.Message

func (*ListClustersRequest) Reset

func (x *ListClustersRequest) Reset()

func (*ListClustersRequest) String

func (x *ListClustersRequest) String() string

type ListClustersResponse

Response message for BigtableClusterService.ListClusters.

type ListClustersResponse struct {

    // The list of requested Clusters.
    Clusters []*Cluster `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
    // The zones for which clusters could not be retrieved.
    FailedZones []*Zone `protobuf:"bytes,2,rep,name=failed_zones,json=failedZones,proto3" json:"failed_zones,omitempty"`
    // contains filtered or unexported fields
}

func (*ListClustersResponse) Descriptor

func (*ListClustersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListClustersResponse.ProtoReflect.Descriptor instead.

func (*ListClustersResponse) GetClusters

func (x *ListClustersResponse) GetClusters() []*Cluster

func (*ListClustersResponse) GetFailedZones

func (x *ListClustersResponse) GetFailedZones() []*Zone

func (*ListClustersResponse) ProtoMessage

func (*ListClustersResponse) ProtoMessage()

func (*ListClustersResponse) ProtoReflect

func (x *ListClustersResponse) ProtoReflect() protoreflect.Message

func (*ListClustersResponse) Reset

func (x *ListClustersResponse) Reset()

func (*ListClustersResponse) String

func (x *ListClustersResponse) String() string

type ListZonesRequest

Request message for BigtableClusterService.ListZones.

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,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

func (*ListZonesRequest) Descriptor

func (*ListZonesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListZonesRequest.ProtoReflect.Descriptor instead.

func (*ListZonesRequest) GetName

func (x *ListZonesRequest) GetName() string

func (*ListZonesRequest) ProtoMessage

func (*ListZonesRequest) ProtoMessage()

func (*ListZonesRequest) ProtoReflect

func (x *ListZonesRequest) ProtoReflect() protoreflect.Message

func (*ListZonesRequest) Reset

func (x *ListZonesRequest) Reset()

func (*ListZonesRequest) String

func (x *ListZonesRequest) String() string

type ListZonesResponse

Response message for BigtableClusterService.ListZones.

type ListZonesResponse struct {

    // The list of requested zones.
    Zones []*Zone `protobuf:"bytes,1,rep,name=zones,proto3" json:"zones,omitempty"`
    // contains filtered or unexported fields
}

func (*ListZonesResponse) Descriptor

func (*ListZonesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListZonesResponse.ProtoReflect.Descriptor instead.

func (*ListZonesResponse) GetZones

func (x *ListZonesResponse) GetZones() []*Zone

func (*ListZonesResponse) ProtoMessage

func (*ListZonesResponse) ProtoMessage()

func (*ListZonesResponse) ProtoReflect

func (x *ListZonesResponse) ProtoReflect() protoreflect.Message

func (*ListZonesResponse) Reset

func (x *ListZonesResponse) Reset()

func (*ListZonesResponse) String

func (x *ListZonesResponse) String() string

type StorageType

type StorageType int32
const (
    // The storage type used is unspecified.
    StorageType_STORAGE_UNSPECIFIED StorageType = 0
    // Data will be stored in SSD, providing low and consistent latencies.
    StorageType_STORAGE_SSD StorageType = 1
    // Data will be stored in HDD, providing high and less predictable
    // latencies.
    StorageType_STORAGE_HDD StorageType = 2
)

func (StorageType) Descriptor

func (StorageType) Descriptor() protoreflect.EnumDescriptor

func (StorageType) Enum

func (x StorageType) Enum() *StorageType

func (StorageType) EnumDescriptor

func (StorageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StorageType.Descriptor instead.

func (StorageType) Number

func (x StorageType) Number() protoreflect.EnumNumber

func (StorageType) String

func (x StorageType) String() string

func (StorageType) Type

func (StorageType) Type() protoreflect.EnumType

type UndeleteClusterMetadata

Metadata type for the operation returned by BigtableClusterService.UndeleteCluster.

type UndeleteClusterMetadata struct {

    // The time at which the original request was received.
    RequestTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
    // The time at which this operation failed or was completed successfully.
    FinishTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
    // contains filtered or unexported fields
}

func (*UndeleteClusterMetadata) Descriptor

func (*UndeleteClusterMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UndeleteClusterMetadata.ProtoReflect.Descriptor instead.

func (*UndeleteClusterMetadata) GetFinishTime

func (x *UndeleteClusterMetadata) GetFinishTime() *timestamppb.Timestamp

func (*UndeleteClusterMetadata) GetRequestTime

func (x *UndeleteClusterMetadata) GetRequestTime() *timestamppb.Timestamp

func (*UndeleteClusterMetadata) ProtoMessage

func (*UndeleteClusterMetadata) ProtoMessage()

func (*UndeleteClusterMetadata) ProtoReflect

func (x *UndeleteClusterMetadata) ProtoReflect() protoreflect.Message

func (*UndeleteClusterMetadata) Reset

func (x *UndeleteClusterMetadata) Reset()

func (*UndeleteClusterMetadata) String

func (x *UndeleteClusterMetadata) String() string

type UndeleteClusterRequest

Request message for BigtableClusterService.UndeleteCluster.

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,proto3" json:"name,omitempty"`
    // contains filtered or unexported fields
}

func (*UndeleteClusterRequest) Descriptor

func (*UndeleteClusterRequest) Descriptor() ([]byte, []int)

Deprecated: Use UndeleteClusterRequest.ProtoReflect.Descriptor instead.

func (*UndeleteClusterRequest) GetName

func (x *UndeleteClusterRequest) GetName() string

func (*UndeleteClusterRequest) ProtoMessage

func (*UndeleteClusterRequest) ProtoMessage()

func (*UndeleteClusterRequest) ProtoReflect

func (x *UndeleteClusterRequest) ProtoReflect() protoreflect.Message

func (*UndeleteClusterRequest) Reset

func (x *UndeleteClusterRequest) Reset()

func (*UndeleteClusterRequest) String

func (x *UndeleteClusterRequest) String() string

type UnimplementedBigtableClusterServiceServer

UnimplementedBigtableClusterServiceServer can be embedded to have forward compatible implementations.

type UnimplementedBigtableClusterServiceServer struct {
}

func (*UnimplementedBigtableClusterServiceServer) CreateCluster

func (*UnimplementedBigtableClusterServiceServer) CreateCluster(context.Context, *CreateClusterRequest) (*Cluster, error)

func (*UnimplementedBigtableClusterServiceServer) DeleteCluster

func (*UnimplementedBigtableClusterServiceServer) DeleteCluster(context.Context, *DeleteClusterRequest) (*emptypb.Empty, error)

func (*UnimplementedBigtableClusterServiceServer) GetCluster

func (*UnimplementedBigtableClusterServiceServer) GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)

func (*UnimplementedBigtableClusterServiceServer) ListClusters

func (*UnimplementedBigtableClusterServiceServer) ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)

func (*UnimplementedBigtableClusterServiceServer) ListZones

func (*UnimplementedBigtableClusterServiceServer) ListZones(context.Context, *ListZonesRequest) (*ListZonesResponse, error)

func (*UnimplementedBigtableClusterServiceServer) UndeleteCluster

func (*UnimplementedBigtableClusterServiceServer) UndeleteCluster(context.Context, *UndeleteClusterRequest) (*longrunning.Operation, error)

func (*UnimplementedBigtableClusterServiceServer) UpdateCluster

func (*UnimplementedBigtableClusterServiceServer) UpdateCluster(context.Context, *Cluster) (*Cluster, error)

type UpdateClusterMetadata

Metadata type for the operation returned by BigtableClusterService.UpdateCluster.

type UpdateClusterMetadata struct {

    // The request which prompted the creation of this operation.
    OriginalRequest *Cluster `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
    // The time at which original_request was received.
    RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
    // The time at which this operation was cancelled. If set, this operation is
    // in the process of undoing itself (which is guaranteed to succeed) and
    // cannot be cancelled again.
    CancelTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
    // The time at which this operation failed or was completed successfully.
    FinishTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
    // contains filtered or unexported fields
}

func (*UpdateClusterMetadata) Descriptor

func (*UpdateClusterMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateClusterMetadata.ProtoReflect.Descriptor instead.

func (*UpdateClusterMetadata) GetCancelTime

func (x *UpdateClusterMetadata) GetCancelTime() *timestamppb.Timestamp

func (*UpdateClusterMetadata) GetFinishTime

func (x *UpdateClusterMetadata) GetFinishTime() *timestamppb.Timestamp

func (*UpdateClusterMetadata) GetOriginalRequest

func (x *UpdateClusterMetadata) GetOriginalRequest() *Cluster

func (*UpdateClusterMetadata) GetRequestTime

func (x *UpdateClusterMetadata) GetRequestTime() *timestamppb.Timestamp

func (*UpdateClusterMetadata) ProtoMessage

func (*UpdateClusterMetadata) ProtoMessage()

func (*UpdateClusterMetadata) ProtoReflect

func (x *UpdateClusterMetadata) ProtoReflect() protoreflect.Message

func (*UpdateClusterMetadata) Reset

func (x *UpdateClusterMetadata) Reset()

func (*UpdateClusterMetadata) String

func (x *UpdateClusterMetadata) String() string

type V2OperationMetadata

Metadata type for operations initiated by the V2 BigtableAdmin service. More complete information for such operations is available via the V2 API.

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

func (*V2OperationMetadata) Descriptor

func (*V2OperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use V2OperationMetadata.ProtoReflect.Descriptor instead.

func (*V2OperationMetadata) ProtoMessage

func (*V2OperationMetadata) ProtoMessage()

func (*V2OperationMetadata) ProtoReflect

func (x *V2OperationMetadata) ProtoReflect() protoreflect.Message

func (*V2OperationMetadata) Reset

func (x *V2OperationMetadata) Reset()

func (*V2OperationMetadata) String

func (x *V2OperationMetadata) String() string

type Zone

A physical location in which a particular project can allocate Cloud BigTable resources.

type Zone struct {

    // A permanent unique identifier for the zone.
    // Values are of the form projects/<project>/zones/[a-z][-a-z0-9]*
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The name of this zone as it appears in UIs.
    DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
    // The current state of this zone.
    Status Zone_Status `protobuf:"varint,3,opt,name=status,proto3,enum=google.bigtable.admin.cluster.v1.Zone_Status" json:"status,omitempty"`
    // contains filtered or unexported fields
}

func (*Zone) Descriptor

func (*Zone) Descriptor() ([]byte, []int)

Deprecated: Use Zone.ProtoReflect.Descriptor instead.

func (*Zone) GetDisplayName

func (x *Zone) GetDisplayName() string

func (*Zone) GetName

func (x *Zone) GetName() string

func (*Zone) GetStatus

func (x *Zone) GetStatus() Zone_Status

func (*Zone) ProtoMessage

func (*Zone) ProtoMessage()

func (*Zone) ProtoReflect

func (x *Zone) ProtoReflect() protoreflect.Message

func (*Zone) Reset

func (x *Zone) Reset()

func (*Zone) String

func (x *Zone) String() string

type Zone_Status

Possible states of a zone.

type Zone_Status int32
const (
    // The state of the zone is unknown or unspecified.
    Zone_UNKNOWN Zone_Status = 0
    // The zone is in a good state.
    Zone_OK Zone_Status = 1
    // The zone is down for planned maintenance.
    Zone_PLANNED_MAINTENANCE Zone_Status = 2
    // The zone is down for emergency or unplanned maintenance.
    Zone_EMERGENCY_MAINENANCE Zone_Status = 3
)

func (Zone_Status) Descriptor

func (Zone_Status) Descriptor() protoreflect.EnumDescriptor

func (Zone_Status) Enum

func (x Zone_Status) Enum() *Zone_Status

func (Zone_Status) EnumDescriptor

func (Zone_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use Zone_Status.Descriptor instead.

func (Zone_Status) Number

func (x Zone_Status) Number() protoreflect.EnumNumber

func (Zone_Status) String

func (x Zone_Status) String() string

func (Zone_Status) Type

func (Zone_Status) Type() protoreflect.EnumType