Movatterモバイル変換

[0]ホーム
URL:

parallelstore

package
v0.12.0Latest Latest
Warning

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

Go to latest Published: Dec 4, 2025 License:Apache-2.0Imports:30Imported by:0

Details

Repository

github.com/googleapis/google-cloud-go

Links

Documentation

Overview

Package parallelstore is an auto-generated package for theParallelstore API.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/parallelstore/apiv1@latestctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req := &parallelstorepb.CreateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#CreateInstanceRequest.}op, err := c.CreateInstance(ctx, req)if err != nil {// TODO: Handle error.}resp, err := op.Wait(ctx)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp

Use of Context

The ctx passed to NewClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

funcDefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

typeCallOptions

type CallOptions struct {ListInstances   []gax.CallOptionGetInstance     []gax.CallOptionCreateInstance  []gax.CallOptionUpdateInstance  []gax.CallOptionDeleteInstance  []gax.CallOptionImportData      []gax.CallOptionExportData      []gax.CallOptionGetLocation     []gax.CallOptionListLocations   []gax.CallOptionCancelOperation []gax.CallOptionDeleteOperation []gax.CallOptionGetOperation    []gax.CallOptionListOperations  []gax.CallOption}

CallOptions contains the retry settings for each method of Client.

typeClient

type Client struct {// The call options for this service.CallOptions *CallOptions// LROClient is used internally to handle long-running operations.// It is exposed so that its CallOptions can be modified if required.// Users should not Close this client.LROClient *lroauto.OperationsClient// contains filtered or unexported fields}

Client is a client for interacting with Parallelstore API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service describing handlers for resourcesConfigures and manages parallelstore resources.

Parallelstore service.

The parallelstore.googleapis.com service implements the parallelstore APIand defines the following resource model for managing instances:

The service works with a collection of cloud projects, named: /projects/*Each project has a collection of available locations, named: /locations/*Each location has a collection of instances named /instances/*.Parallelstore instances are resources of the form:/projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a Google Cloud zone; for example:

projects/12345/locations/us-central1-c/instances/my-parallelstore-share

funcNewClient

func NewClient(ctxcontext.Context, opts ...option.ClientOption) (*Client,error)

NewClient creates a new parallelstore client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

Service describing handlers for resourcesConfigures and manages parallelstore resources.

Parallelstore service.

The parallelstore.googleapis.com service implements the parallelstore APIand defines the following resource model for managing instances:

The service works with a collection of cloud projects, named: /projects/*Each project has a collection of available locations, named: /locations/*Each location has a collection of instances named /instances/*.Parallelstore instances are resources of the form:/projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a Google Cloud zone; for example:

projects/12345/locations/us-central1-c/instances/my-parallelstore-share
Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()// TODO: Use client._ = c}

funcNewRESTClient

func NewRESTClient(ctxcontext.Context, opts ...option.ClientOption) (*Client,error)

NewRESTClient creates a new parallelstore rest client.

Service describing handlers for resourcesConfigures and manages parallelstore resources.

Parallelstore service.

The parallelstore.googleapis.com service implements the parallelstore APIand defines the following resource model for managing instances:

The service works with a collection of cloud projects, named: /projects/*Each project has a collection of available locations, named: /locations/*Each location has a collection of instances named /instances/*.Parallelstore instances are resources of the form:/projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a Google Cloud zone; for example:

projects/12345/locations/us-central1-c/instances/my-parallelstore-share
Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewRESTClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()// TODO: Use client._ = c}

func (*Client)CancelOperation

func (c *Client) CancelOperation(ctxcontext.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption)error

CancelOperation is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"parallelstore "cloud.google.com/go/parallelstore/apiv1")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.CancelOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.}err = c.CancelOperation(ctx, req)if err != nil {// TODO: Handle error.}}

func (*Client)Close

func (c *Client) Close()error

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

func (*Client)Connectiondeprecated

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

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client)CreateInstance

CreateInstance creates a Parallelstore instance in a given project and location.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.CreateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#CreateInstanceRequest.}op, err := c.CreateInstance(ctx, req)if err != nil {// TODO: Handle error.}resp, err := op.Wait(ctx)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)CreateInstanceOperation

func (c *Client) CreateInstanceOperation(namestring) *CreateInstanceOperation

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

func (*Client)DeleteInstance

DeleteInstance deletes a single instance.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.DeleteInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#DeleteInstanceRequest.}op, err := c.DeleteInstance(ctx, req)if err != nil {// TODO: Handle error.}err = op.Wait(ctx)if err != nil {// TODO: Handle error.}}

func (*Client)DeleteInstanceOperation

func (c *Client) DeleteInstanceOperation(namestring) *DeleteInstanceOperation

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

func (*Client)DeleteOperation

func (c *Client) DeleteOperation(ctxcontext.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption)error

DeleteOperation is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"parallelstore "cloud.google.com/go/parallelstore/apiv1")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.DeleteOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.}err = c.DeleteOperation(ctx, req)if err != nil {// TODO: Handle error.}}

func (*Client)ExportData

ExportData copies data from Parallelstore to Cloud Storage.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.ExportDataRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#ExportDataRequest.}op, err := c.ExportData(ctx, req)if err != nil {// TODO: Handle error.}resp, err := op.Wait(ctx)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)ExportDataOperation

func (c *Client) ExportDataOperation(namestring) *ExportDataOperation

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

func (*Client)GetInstance

GetInstance gets details of a single instance.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.GetInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#GetInstanceRequest.}resp, err := c.GetInstance(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)GetLocation

GetLocation gets information about a location.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"locationpb "google.golang.org/genproto/googleapis/cloud/location")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &locationpb.GetLocationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.}resp, err := c.GetLocation(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)GetOperation

GetOperation is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"parallelstore "cloud.google.com/go/parallelstore/apiv1")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.}resp, err := c.GetOperation(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)ImportData

ImportData copies data from Cloud Storage to Parallelstore.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.ImportDataRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#ImportDataRequest.}op, err := c.ImportData(ctx, req)if err != nil {// TODO: Handle error.}resp, err := op.Wait(ctx)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)ImportDataOperation

func (c *Client) ImportDataOperation(namestring) *ImportDataOperation

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

func (*Client)ListInstances

ListInstances lists all instances in a given project and location.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb""google.golang.org/api/iterator")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#ListInstancesRequest.}it := c.ListInstances(ctx, req)for {resp, err := it.Next()if err == iterator.Done {break}if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._ = it.Response.(*parallelstorepb.ListInstancesResponse)}}

Example (All)
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#ListInstancesRequest.}for resp, err := range c.ListInstances(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)ListLocations

ListLocations lists information about the supported locations for this service.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1""google.golang.org/api/iterator"locationpb "google.golang.org/genproto/googleapis/cloud/location")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}it := c.ListLocations(ctx, req)for {resp, err := it.Next()if err == iterator.Done {break}if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._ = it.Response.(*locationpb.ListLocationsResponse)}}

Example (All)
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"locationpb "google.golang.org/genproto/googleapis/cloud/location")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}for resp, err := range c.ListLocations(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)ListOperations

ListOperations is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"parallelstore "cloud.google.com/go/parallelstore/apiv1""google.golang.org/api/iterator")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}it := c.ListOperations(ctx, req)for {resp, err := it.Next()if err == iterator.Done {break}if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._ = it.Response.(*longrunningpb.ListOperationsResponse)}}

Example (All)
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"parallelstore "cloud.google.com/go/parallelstore/apiv1")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}for resp, err := range c.ListOperations(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)UpdateInstance

UpdateInstance updates the parameters of a single instance.

Example
package mainimport ("context"parallelstore "cloud.google.com/go/parallelstore/apiv1"parallelstorepb "cloud.google.com/go/parallelstore/apiv1/parallelstorepb")func main() {ctx := context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc, err := parallelstore.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &parallelstorepb.UpdateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/parallelstore/apiv1/parallelstorepb#UpdateInstanceRequest.}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}

func (*Client)UpdateInstanceOperation

func (c *Client) UpdateInstanceOperation(namestring) *UpdateInstanceOperation

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

typeCreateInstanceOperation

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

CreateInstanceOperation manages a long-running operation from CreateInstance.

func (*CreateInstanceOperation)Done

func (op *CreateInstanceOperation) Done()bool

Done reports whether the long-running operation has completed.

func (*CreateInstanceOperation)Metadata

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

func (*CreateInstanceOperation)Name

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

func (*CreateInstanceOperation)Poll

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 andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateInstanceOperation)Wait

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

See documentation of Poll for error-handling information.

typeDeleteInstanceOperation

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

DeleteInstanceOperation manages a long-running operation from DeleteInstance.

func (*DeleteInstanceOperation)Done

func (op *DeleteInstanceOperation) Done()bool

Done reports whether the long-running operation has completed.

func (*DeleteInstanceOperation)Metadata

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 (*DeleteInstanceOperation)Name

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 (*DeleteInstanceOperation)Poll

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 andthe 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 (*DeleteInstanceOperation)Wait

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

See documentation of Poll for error-handling information.

typeExportDataOperation

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

ExportDataOperation manages a long-running operation from ExportData.

func (*ExportDataOperation)Done

func (op *ExportDataOperation) Done()bool

Done reports whether the long-running operation has completed.

func (*ExportDataOperation)Metadata

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 (*ExportDataOperation)Name

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

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 andthe 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 (*ExportDataOperation)Wait

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

See documentation of Poll for error-handling information.

typeImportDataOperation

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

ImportDataOperation manages a long-running operation from ImportData.

func (*ImportDataOperation)Done

func (op *ImportDataOperation) Done()bool

Done reports whether the long-running operation has completed.

func (*ImportDataOperation)Metadata

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 (*ImportDataOperation)Name

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

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 andthe 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 (*ImportDataOperation)Wait

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

See documentation of Poll for error-handling information.

typeInstanceIterator

type InstanceIterator struct {// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Response interface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetch func(pageSizeint, pageTokenstring) (results []*parallelstorepb.Instance, nextPageTokenstring, errerror)// contains filtered or unexported fields}

InstanceIterator manages a stream of *parallelstorepb.Instance.

func (*InstanceIterator)All

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

func (*InstanceIterator)Next

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

func (*InstanceIterator)PageInfo

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

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

typeLocationIterator

type LocationIterator struct {// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Response interface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetch func(pageSizeint, pageTokenstring) (results []*locationpb.Location, nextPageTokenstring, errerror)// contains filtered or unexported fields}

LocationIterator manages a stream of *locationpb.Location.

func (*LocationIterator)All

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

func (*LocationIterator)Next

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

func (*LocationIterator)PageInfo

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

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

typeOperationIterator

type OperationIterator struct {// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Response interface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetch func(pageSizeint, pageTokenstring) (results []*longrunningpb.Operation, nextPageTokenstring, errerror)// contains filtered or unexported fields}

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator)All

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

func (*OperationIterator)Next

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

func (*OperationIterator)PageInfo

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

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

typeUpdateInstanceOperation

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

UpdateInstanceOperation manages a long-running operation from UpdateInstance.

func (*UpdateInstanceOperation)Done

func (op *UpdateInstanceOperation) Done()bool

Done reports whether the long-running operation has completed.

func (*UpdateInstanceOperation)Metadata

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 (*UpdateInstanceOperation)Name

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 (*UpdateInstanceOperation)Poll

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 andthe 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 (*UpdateInstanceOperation)Wait

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

Directories

PathSynopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2026 Movatter.jp