instance

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package instance is an experimental, auto-generated package for the instance API.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func InstanceAdminInstanceConfigPath 

func InstanceAdminInstanceConfigPath(project, instanceConfig string) string

InstanceAdminInstanceConfigPath returns the path for the instance config resource.

func InstanceAdminInstancePath 

func InstanceAdminInstancePath(project, instance string) string

InstanceAdminInstancePath returns the path for the instance resource.

func InstanceAdminProjectPath 

func InstanceAdminProjectPath(project string) string

InstanceAdminProjectPath returns the path for the project resource.

Types

type InstanceAdminCallOptions 

type InstanceAdminCallOptions struct {
	ListInstanceConfigs []gax.CallOption
	GetInstanceConfig   []gax.CallOption
	ListInstances       []gax.CallOption
	GetInstance         []gax.CallOption
	CreateInstance      []gax.CallOption
	UpdateInstance      []gax.CallOption
	DeleteInstance      []gax.CallOption
	SetIamPolicy        []gax.CallOption
	GetIamPolicy        []gax.CallOption
	TestIamPermissions  []gax.CallOption
}

InstanceAdminCallOptions contains the retry settings for each method of InstanceAdminClient.

type InstanceAdminClient 

type InstanceAdminClient struct {

	// The call options for this service.
	CallOptions *InstanceAdminCallOptions
	// contains filtered or unexported fields
}

InstanceAdminClient is a client for interacting with Cloud Spanner Instance Admin API.

func NewInstanceAdminClient 

func NewInstanceAdminClient(ctx context.Context, opts ...option.ClientOption) (*InstanceAdminClient, error)

NewInstanceAdminClient creates a new instance admin client.

Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c

Output:

func (*InstanceAdminClient) Close 

func (c *InstanceAdminClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*InstanceAdminClient) Connection 

func (c *InstanceAdminClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*InstanceAdminClient) CreateInstance 

func (c *InstanceAdminClient) CreateInstance(ctx context.Context, req *instancepb.CreateInstanceRequest) (*InstanceOperation, error)

CreateInstance creates an instance and begins preparing it to begin serving. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`.

Immediately upon completion of this request:

  • The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`.

Until completion of the returned operation:

  • Cancelling the operation renders the instance immediately unreadable via the API.
  • The instance can be deleted.
  • All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

  • Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
  • Databases can be created in the instance.
  • The instance's allocated resource levels are readable via the API.
  • The instance's state becomes `READY`.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track creation of the instance. The metadata[google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.CreateInstanceRequest{
	// TODO: Fill request struct fields.
}
op, err := c.CreateInstance(ctx, req)
if err != nil {
	// TODO: Handle error.
}

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

Output:

func (*InstanceAdminClient) DeleteInstance 

func (c *InstanceAdminClient) DeleteInstance(ctx context.Context, req *instancepb.DeleteInstanceRequest) error

DeleteInstance deletes an instance.

Immediately upon completion of the request:

  • Billing ceases for all of the instance's reserved resources.

Soon afterward:

  • The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.DeleteInstanceRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteInstance(ctx, req)
if err != nil {
	// TODO: Handle error.
}

Output:

func (*InstanceAdminClient) GetIamPolicy 

func (c *InstanceAdminClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest) (*iampb.Policy, error)

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

Authorization requires `spanner.instances.getIamPolicy` on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &iampb.GetIamPolicyRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*InstanceAdminClient) GetInstance 

func (c *InstanceAdminClient) GetInstance(ctx context.Context, req *instancepb.GetInstanceRequest) (*instancepb.Instance, error)

GetInstance gets information about a particular instance.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.GetInstanceRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetInstance(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*InstanceAdminClient) GetInstanceConfig 

func (c *InstanceAdminClient) GetInstanceConfig(ctx context.Context, req *instancepb.GetInstanceConfigRequest) (*instancepb.InstanceConfig, error)

GetInstanceConfig gets information about a particular instance configuration.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.GetInstanceConfigRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetInstanceConfig(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*InstanceAdminClient) InstanceOperation 

func (c *InstanceAdminClient) InstanceOperation(name string) *InstanceOperation

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

func (*InstanceAdminClient) ListInstanceConfigs 

func (c *InstanceAdminClient) ListInstanceConfigs(ctx context.Context, req *instancepb.ListInstanceConfigsRequest) *InstanceConfigIterator

ListInstanceConfigs lists the supported instance configurations for a given project.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.ListInstanceConfigsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListInstanceConfigs(ctx, req)
for {
	resp, err := it.Next()
	if err != nil {
		// TODO: Handle error.
		break
	}
	// TODO: Use resp.
	_ = resp
}

Output:

func (*InstanceAdminClient) ListInstances 

func (c *InstanceAdminClient) ListInstances(ctx context.Context, req *instancepb.ListInstancesRequest) *InstanceIterator

ListInstances lists all instances in the given project.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.ListInstancesRequest{
	// TODO: Fill request struct fields.
}
it := c.ListInstances(ctx, req)
for {
	resp, err := it.Next()
	if err != nil {
		// TODO: Handle error.
		break
	}
	// TODO: Use resp.
	_ = resp
}

Output:

func (*InstanceAdminClient) SetGoogleClientInfo 

func (c *InstanceAdminClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*InstanceAdminClient) SetIamPolicy 

func (c *InstanceAdminClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest) (*iampb.Policy, error)

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

Authorization requires `spanner.instances.setIamPolicy` on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &iampb.SetIamPolicyRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*InstanceAdminClient) TestIamPermissions 

func (c *InstanceAdminClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)

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

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &iampb.TestIamPermissionsRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Output:

func (*InstanceAdminClient) UpdateInstance 

func (c *InstanceAdminClient) UpdateInstance(ctx context.Context, req *instancepb.UpdateInstanceRequest) (*InstanceOperation, error)

UpdateInstance updates an instance, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`.

Immediately upon completion of this request:

  • For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

  • Cancelling the operation sets its metadata's [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status.
  • All other attempts to modify the instance are rejected.
  • Reading the instance via the API continues to give the pre-request resource levels.

Upon completion of the returned operation:

  • Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
  • All newly-reserved resources are available for serving the instance's tables.
  • The instance's new resource levels are readable via the API.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the instance modification. The metadata[google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.

Authorization requires `spanner.instances.update` permission on resource [name][google.spanner.admin.instance.v1.Instance.name].

Example 
ctx := context.Background()
c, err := instance.NewInstanceAdminClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &instancepb.UpdateInstanceRequest{
	// TODO: Fill request struct fields.
}
op, err := c.UpdateInstance(ctx, req)
if err != nil {
	// TODO: Handle error.
}

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

Output:

type InstanceConfigIterator 

type InstanceConfigIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*instancepb.InstanceConfig, nextPageToken string, err error)
	// contains filtered or unexported fields
}

InstanceConfigIterator manages a stream of *instancepb.InstanceConfig.

func (*InstanceConfigIterator) Next 

func (it *InstanceConfigIterator) Next() (*instancepb.InstanceConfig, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*InstanceConfigIterator) PageInfo 

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

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

type InstanceIterator 

type InstanceIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*instancepb.Instance, nextPageToken string, err error)
	// contains filtered or unexported fields
}

InstanceIterator manages a stream of *instancepb.Instance.

func (*InstanceIterator) Next 

func (it *InstanceIterator) Next() (*instancepb.Instance, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*InstanceIterator) PageInfo 

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

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

type InstanceOperation 

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

InstanceOperation manages a long-running operation yielding instancepb.Instance.

func (*InstanceOperation) Done 

func (op *InstanceOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*InstanceOperation) Metadata 

func (op *InstanceOperation) Metadata() (*instancepb.UpdateInstanceMetadata, error)

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

func (*InstanceOperation) Name 

func (op *InstanceOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*InstanceOperation) Poll 

func (op *InstanceOperation) Poll(ctx context.Context) (*instancepb.Instance, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*InstanceOperation) Wait 

func (op *InstanceOperation) Wait(ctx context.Context) (*instancepb.Instance, error)

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

See documentation of Poll for error-handling information.

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.