bigtableclusteradmin

package
v0.0.0-...-9b87225 Latest Latest
Warning

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

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

Documentation

Overview

Package bigtableclusteradmin provides access to the Google Cloud Bigtable Cluster Admin API.

See https://cloud.google.com/bigtable/

Usage example: 

import "github.com/skelterjohn/gcloud_apis/clients/bigtableclusteradmin/v1"
...
bigtableclusteradminService, err := bigtableclusteradmin.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud Platform services
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelOperationRequest 

type CancelOperationRequest struct {
}

type Cluster 

type Cluster struct {
	CurrentOperation *Operation `json:"currentOperation,omitempty"`

	// Possible values:
	//   "STORAGE_HDD"
	//   "STORAGE_SSD"
	//   "STORAGE_UNSPECIFIED"
	DefaultStorageType string `json:"defaultStorageType,omitempty"`

	DisplayName string `json:"displayName,omitempty"`

	HddBytes int64 `json:"hddBytes,omitempty,string"`

	Name string `json:"name,omitempty"`

	ServeNodes int64 `json:"serveNodes,omitempty"`

	SsdBytes int64 `json:"ssdBytes,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CurrentOperation") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Cluster) MarshalJSON 

func (s *Cluster) MarshalJSON() ([]byte, error)

type CreateClusterRequest 

type CreateClusterRequest struct {
	Cluster *Cluster `json:"cluster,omitempty"`

	ClusterId string `json:"clusterId,omitempty"`

	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Cluster") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*CreateClusterRequest) MarshalJSON 

func (s *CreateClusterRequest) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

type ListClustersResponse 

type ListClustersResponse struct {
	Clusters []*Cluster `json:"clusters,omitempty"`

	FailedZones []*Zone `json:"failedZones,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Clusters") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ListClustersResponse) MarshalJSON 

func (s *ListClustersResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse 

type ListOperationsResponse struct {
	NextPageToken string `json:"nextPageToken,omitempty"`

	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ListOperationsResponse) MarshalJSON 

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListZonesResponse 

type ListZonesResponse struct {
	Zones []*Zone `json:"zones,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Zones") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*ListZonesResponse) MarshalJSON 

func (s *ListZonesResponse) MarshalJSON() ([]byte, error)

type Operation 

type Operation struct {
	Done bool `json:"done,omitempty"`

	Error *Status `json:"error,omitempty"`

	Metadata OperationMetadata `json:"metadata,omitempty"`

	Name string `json:"name,omitempty"`

	Response OperationResponse `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Operation) MarshalJSON 

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationMetadata 

type OperationMetadata interface{}

type OperationResponse 

type OperationResponse interface{}

type OperationsCancelCall 

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

func (*OperationsCancelCall) Context 

func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsCancelCall) Do 

func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "bigtableclusteradmin.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsCancelCall) Fields 

func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type OperationsDeleteCall 

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

func (*OperationsDeleteCall) Context 

func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsDeleteCall) Do 

func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "bigtableclusteradmin.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsDeleteCall) Fields 

func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type OperationsGetCall 

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

func (*OperationsGetCall) Context 

func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsGetCall) Do 

func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "bigtableclusteradmin.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields 

func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsGetCall) IfNoneMatch 

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OperationsListCall 

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

func (*OperationsListCall) Context 

func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OperationsListCall) Do 

func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "bigtableclusteradmin.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsListCall) Fields 

func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsListCall) Filter 

func (c *OperationsListCall) Filter(filter string) *OperationsListCall

Filter sets the optional parameter "filter":

func (*OperationsListCall) IfNoneMatch 

func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OperationsListCall) PageSize 

func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall

PageSize sets the optional parameter "pageSize":

func (*OperationsListCall) PageToken 

func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall

PageToken sets the optional parameter "pageToken":

func (*OperationsListCall) Pages 

func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OperationsService 

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

func NewOperationsService 

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Cancel 

func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.

func (*OperationsService) Delete 

func (r *OperationsService) Delete(name string) *OperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

func (*OperationsService) Get 

func (r *OperationsService) Get(name string) *OperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

func (*OperationsService) List 

func (r *OperationsService) List(name string) *OperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

type ProjectsAggregatedClustersListCall 

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

func (*ProjectsAggregatedClustersListCall) Context 

func (c *ProjectsAggregatedClustersListCall) Context(ctx context.Context) *ProjectsAggregatedClustersListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsAggregatedClustersListCall) Do 

func (c *ProjectsAggregatedClustersListCall) Do(opts ...googleapi.CallOption) (*ListClustersResponse, error)

Do executes the "bigtableclusteradmin.projects.aggregated.clusters.list" call. Exactly one of *ListClustersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListClustersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAggregatedClustersListCall) Fields 

func (c *ProjectsAggregatedClustersListCall) Fields(s ...googleapi.Field) *ProjectsAggregatedClustersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsAggregatedClustersListCall) IfNoneMatch 

func (c *ProjectsAggregatedClustersListCall) IfNoneMatch(entityTag string) *ProjectsAggregatedClustersListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsAggregatedClustersService 

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

func NewProjectsAggregatedClustersService 

func NewProjectsAggregatedClustersService(s *Service) *ProjectsAggregatedClustersService

func (*ProjectsAggregatedClustersService) List 

func (r *ProjectsAggregatedClustersService) List(name string) *ProjectsAggregatedClustersListCall

List: Lists all clusters in the given project, along with any zones for which cluster information could not be retrieved.

type ProjectsAggregatedService 

type ProjectsAggregatedService struct {
	Clusters *ProjectsAggregatedClustersService
	// contains filtered or unexported fields
}

func NewProjectsAggregatedService 

func NewProjectsAggregatedService(s *Service) *ProjectsAggregatedService

type ProjectsService 

type ProjectsService struct {
	Aggregated *ProjectsAggregatedService

	Zones *ProjectsZonesService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type ProjectsZonesClustersCreateCall 

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

func (*ProjectsZonesClustersCreateCall) Context 

func (c *ProjectsZonesClustersCreateCall) Context(ctx context.Context) *ProjectsZonesClustersCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesClustersCreateCall) Do 

func (c *ProjectsZonesClustersCreateCall) Do(opts ...googleapi.CallOption) (*Cluster, error)

Do executes the "bigtableclusteradmin.projects.zones.clusters.create" call. Exactly one of *Cluster or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Cluster.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesClustersCreateCall) Fields 

func (c *ProjectsZonesClustersCreateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersDeleteCall 

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

func (*ProjectsZonesClustersDeleteCall) Context 

func (c *ProjectsZonesClustersDeleteCall) Context(ctx context.Context) *ProjectsZonesClustersDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesClustersDeleteCall) Do 

func (c *ProjectsZonesClustersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "bigtableclusteradmin.projects.zones.clusters.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesClustersDeleteCall) Fields 

func (c *ProjectsZonesClustersDeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersGetCall 

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

func (*ProjectsZonesClustersGetCall) Context 

func (c *ProjectsZonesClustersGetCall) Context(ctx context.Context) *ProjectsZonesClustersGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesClustersGetCall) Do 

func (c *ProjectsZonesClustersGetCall) Do(opts ...googleapi.CallOption) (*Cluster, error)

Do executes the "bigtableclusteradmin.projects.zones.clusters.get" call. Exactly one of *Cluster or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Cluster.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesClustersGetCall) Fields 

func (c *ProjectsZonesClustersGetCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsZonesClustersGetCall) IfNoneMatch 

func (c *ProjectsZonesClustersGetCall) IfNoneMatch(entityTag string) *ProjectsZonesClustersGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsZonesClustersPatchCall 

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

func (*ProjectsZonesClustersPatchCall) Context 

func (c *ProjectsZonesClustersPatchCall) Context(ctx context.Context) *ProjectsZonesClustersPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesClustersPatchCall) Do 

func (c *ProjectsZonesClustersPatchCall) Do(opts ...googleapi.CallOption) (*Cluster, error)

Do executes the "bigtableclusteradmin.projects.zones.clusters.patch" call. Exactly one of *Cluster or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Cluster.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesClustersPatchCall) Fields 

func (c *ProjectsZonesClustersPatchCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersService 

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

func NewProjectsZonesClustersService 

func NewProjectsZonesClustersService(s *Service) *ProjectsZonesClustersService

func (*ProjectsZonesClustersService) Create 

func (r *ProjectsZonesClustersService) Create(name string, createclusterrequest *CreateClusterRequest) *ProjectsZonesClustersCreateCall

Create: 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.CreateCluster Metadata] The embedded operation's "response" field type is Cluster[google.bigtable.admin.cluster.v1.Cluster], if successful.

func (*ProjectsZonesClustersService) Delete 

func (r *ProjectsZonesClustersService) Delete(name string) *ProjectsZonesClustersDeleteCall

Delete: 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.

func (*ProjectsZonesClustersService) Get 

func (r *ProjectsZonesClustersService) Get(name string) *ProjectsZonesClustersGetCall

Get: Gets information about a particular cluster.

func (*ProjectsZonesClustersService) Patch 

func (r *ProjectsZonesClustersService) Patch(name string, cluster *Cluster) *ProjectsZonesClustersPatchCall

Patch: 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.UpdateCluster Metadata] The embedded operation's "response" field type is Cluster[google.bigtable.admin.cluster.v1.Cluster], if successful. This method supports patch semantics.

func (*ProjectsZonesClustersService) Undelete 

func (r *ProjectsZonesClustersService) Undelete(name string) *ProjectsZonesClustersUndeleteCall

Undelete: 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.UndeleteClu sterMetadata] The embedded operation's "response" field type is Cluster[google.bigtable.admin.cluster.v1.Cluster], if successful.

func (*ProjectsZonesClustersService) Update 

func (r *ProjectsZonesClustersService) Update(name string, cluster *Cluster) *ProjectsZonesClustersUpdateCall

Update: 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.UpdateCluster Metadata] The embedded operation's "response" field type is Cluster[google.bigtable.admin.cluster.v1.Cluster], if successful.

type ProjectsZonesClustersUndeleteCall 

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

func (*ProjectsZonesClustersUndeleteCall) Context 

func (c *ProjectsZonesClustersUndeleteCall) Context(ctx context.Context) *ProjectsZonesClustersUndeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesClustersUndeleteCall) Do 

func (c *ProjectsZonesClustersUndeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "bigtableclusteradmin.projects.zones.clusters.undelete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesClustersUndeleteCall) Fields 

func (c *ProjectsZonesClustersUndeleteCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersUndeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesClustersUpdateCall 

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

func (*ProjectsZonesClustersUpdateCall) Context 

func (c *ProjectsZonesClustersUpdateCall) Context(ctx context.Context) *ProjectsZonesClustersUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesClustersUpdateCall) Do 

func (c *ProjectsZonesClustersUpdateCall) Do(opts ...googleapi.CallOption) (*Cluster, error)

Do executes the "bigtableclusteradmin.projects.zones.clusters.update" call. Exactly one of *Cluster or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Cluster.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesClustersUpdateCall) Fields 

func (c *ProjectsZonesClustersUpdateCall) Fields(s ...googleapi.Field) *ProjectsZonesClustersUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsZonesListCall 

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

func (*ProjectsZonesListCall) Context 

func (c *ProjectsZonesListCall) Context(ctx context.Context) *ProjectsZonesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsZonesListCall) Do 

func (c *ProjectsZonesListCall) Do(opts ...googleapi.CallOption) (*ListZonesResponse, error)

Do executes the "bigtableclusteradmin.projects.zones.list" call. Exactly one of *ListZonesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListZonesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsZonesListCall) Fields 

func (c *ProjectsZonesListCall) Fields(s ...googleapi.Field) *ProjectsZonesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsZonesListCall) IfNoneMatch 

func (c *ProjectsZonesListCall) IfNoneMatch(entityTag string) *ProjectsZonesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsZonesService 

type ProjectsZonesService struct {
	Clusters *ProjectsZonesClustersService
	// contains filtered or unexported fields
}

func NewProjectsZonesService 

func NewProjectsZonesService(s *Service) *ProjectsZonesService

func (*ProjectsZonesService) List 

func (r *ProjectsZonesService) List(name string) *ProjectsZonesListCall

List: Lists the supported zones for the given project.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Operations *OperationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type Status 

type Status struct {
	Code int64 `json:"code,omitempty"`

	Details []StatusDetails `json:"details,omitempty"`

	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Status) MarshalJSON 

func (s *Status) MarshalJSON() ([]byte, error)

type StatusDetails 

type StatusDetails interface{}

type Zone 

type Zone struct {
	DisplayName string `json:"displayName,omitempty"`

	Name string `json:"name,omitempty"`

	// Possible values:
	//   "EMERGENCY_MAINENANCE"
	//   "OK"
	//   "PLANNED_MAINTENANCE"
	//   "UNKNOWN"
	Status string `json:"status,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*Zone) MarshalJSON 

func (s *Zone) MarshalJSON() ([]byte, error)

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.