Memorystore API v1 - Package cloud.google.com/go/memorystore/apiv1 (v0.3.1)
Beta
This library is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see thelaunch stage descriptions.
Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.Package memorystore is an auto-generated package for theMemorystore API.
NOTE:Thispackageisinbeta.Itisnotstable,andmaybesubjecttochanges.
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:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/memorystore/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:=memorystore.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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:=&memorystorepb.BackupInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#BackupInstanceRequest.}op,err:=c.BackupInstance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=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.
Functions
func DefaultAuthScopes
funcDefaultAuthScopes()[]stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
BackupCollectionIterator
typeBackupCollectionIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*memorystorepb.BackupCollection,nextPageTokenstring,errerror)// contains filtered or unexported fields}BackupCollectionIterator manages a stream of *memorystorepb.BackupCollection.
func (*BackupCollectionIterator) All
func(it*BackupCollectionIterator)All()iter.Seq2[*memorystorepb.BackupCollection,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*BackupCollectionIterator) Next
func(it*BackupCollectionIterator)Next()(*memorystorepb.BackupCollection,error)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 (*BackupCollectionIterator) PageInfo
func(it*BackupCollectionIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
BackupInstanceOperation
typeBackupInstanceOperationstruct{// contains filtered or unexported fields}BackupInstanceOperation manages a long-running operation from BackupInstance.
func (*BackupInstanceOperation) Done
func(op*BackupInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*BackupInstanceOperation) Metadata
func(op*BackupInstanceOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*BackupInstanceOperation) Name
func(op*BackupInstanceOperation)Name()stringName 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 (*BackupInstanceOperation) Poll
func(op*BackupInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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 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 (*BackupInstanceOperation) Wait
func(op*BackupInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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.
BackupIterator
typeBackupIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*memorystorepb.Backup,nextPageTokenstring,errerror)// contains filtered or unexported fields}BackupIterator manages a stream of *memorystorepb.Backup.
func (*BackupIterator) All
func(it*BackupIterator)All()iter.Seq2[*memorystorepb.Backup,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*BackupIterator) Next
func(it*BackupIterator)Next()(*memorystorepb.Backup,error)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 (*BackupIterator) PageInfo
func(it*BackupIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CallOptions
typeCallOptionsstruct{ListInstances[]gax.CallOptionGetInstance[]gax.CallOptionCreateInstance[]gax.CallOptionUpdateInstance[]gax.CallOptionDeleteInstance[]gax.CallOptionGetCertificateAuthority[]gax.CallOptionRescheduleMaintenance[]gax.CallOptionListBackupCollections[]gax.CallOptionGetBackupCollection[]gax.CallOptionListBackups[]gax.CallOptionGetBackup[]gax.CallOptionDeleteBackup[]gax.CallOptionExportBackup[]gax.CallOptionBackupInstance[]gax.CallOptionGetLocation[]gax.CallOptionListLocations[]gax.CallOptionCancelOperation[]gax.CallOptionDeleteOperation[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}CallOptions contains the retry settings for each method of Client.
Client
typeClientstruct{// 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 Memorystore API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service describing handlers for resources
func NewRESTClient
NewRESTClient creates a new memorystore rest client.
Service describing handlers for resources
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func (*Client) BackupInstance
func(c*Client)BackupInstance(ctxcontext.Context,req*memorystorepb.BackupInstanceRequest,opts...gax.CallOption)(*BackupInstanceOperation,error)BackupInstance backup Instance.If this is the first time a backup is being created, a backup collectionwill be created at the backend, and this backup belongs to this collection.Both collection and backup will have a resource name. Backup will beexecuted for each shard. A replica (primary if nonHA) will be selected toperform the execution. Backup call will be rejected if there is an ongoingbackup or update operation. Be aware that during preview, if the instance’sinternal software version is too old, critical update will be performedbefore actual backup. Once the internal software version is updated to theminimum version required by the backup feature, subsequent backups will notrequire critical update. After preview, there will be no critical updateneeded for backup.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.BackupInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#BackupInstanceRequest.}op,err:=c.BackupInstance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) BackupInstanceOperation
func(c*Client)BackupInstanceOperation(namestring)*BackupInstanceOperationBackupInstanceOperation returns a new BackupInstanceOperation from a given name.The name must be that of a previously created BackupInstanceOperation, possibly from a different process.
func (*Client) CancelOperation
func(c*Client)CancelOperation(ctxcontext.Context,req*longrunningpb.CancelOperationRequest,opts...gax.CallOption)errorCancelOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memorystore"cloud.google.com/go/memorystore/apiv1")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}}func (*Client) Close
Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.
func (*Client) Connection (deprecated)
func(c*Client)Connection()*grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.
func (*Client) CreateInstance
func(c*Client)CreateInstance(ctxcontext.Context,req*memorystorepb.CreateInstanceRequest,opts...gax.CallOption)(*CreateInstanceOperation,error)CreateInstance creates a new Instance in a given project and location.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.CreateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#CreateInstanceRequest.}op,err:=c.CreateInstance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) CreateInstanceOperation
func(c*Client)CreateInstanceOperation(namestring)*CreateInstanceOperationCreateInstanceOperation 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) DeleteBackup
func(c*Client)DeleteBackup(ctxcontext.Context,req*memorystorepb.DeleteBackupRequest,opts...gax.CallOption)(*DeleteBackupOperation,error)DeleteBackup deletes a specific backup.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.DeleteBackupRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#DeleteBackupRequest.}op,err:=c.DeleteBackup(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*Client) DeleteBackupOperation
func(c*Client)DeleteBackupOperation(namestring)*DeleteBackupOperationDeleteBackupOperation returns a new DeleteBackupOperation from a given name.The name must be that of a previously created DeleteBackupOperation, possibly from a different process.
func (*Client) DeleteInstance
func(c*Client)DeleteInstance(ctxcontext.Context,req*memorystorepb.DeleteInstanceRequest,opts...gax.CallOption)(*DeleteInstanceOperation,error)DeleteInstance deletes a single Instance.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.DeleteInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#DeleteInstanceRequest.}op,err:=c.DeleteInstance(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*Client) DeleteInstanceOperation
func(c*Client)DeleteInstanceOperation(namestring)*DeleteInstanceOperationDeleteInstanceOperation 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)errorDeleteOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memorystore"cloud.google.com/go/memorystore/apiv1")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}}func (*Client) ExportBackup
func(c*Client)ExportBackup(ctxcontext.Context,req*memorystorepb.ExportBackupRequest,opts...gax.CallOption)(*ExportBackupOperation,error)ExportBackup exports a specific backup to a customer target Cloud Storage URI.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ExportBackupRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ExportBackupRequest.}op,err:=c.ExportBackup(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) ExportBackupOperation
func(c*Client)ExportBackupOperation(namestring)*ExportBackupOperationExportBackupOperation returns a new ExportBackupOperation from a given name.The name must be that of a previously created ExportBackupOperation, possibly from a different process.
func (*Client) GetBackup
func(c*Client)GetBackup(ctxcontext.Context,req*memorystorepb.GetBackupRequest,opts...gax.CallOption)(*memorystorepb.Backup,error)GetBackup gets the details of a specific backup.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.GetBackupRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#GetBackupRequest.}resp,err:=c.GetBackup(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetBackupCollection
func(c*Client)GetBackupCollection(ctxcontext.Context,req*memorystorepb.GetBackupCollectionRequest,opts...gax.CallOption)(*memorystorepb.BackupCollection,error)GetBackupCollection get a backup collection.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.GetBackupCollectionRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#GetBackupCollectionRequest.}resp,err:=c.GetBackupCollection(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetCertificateAuthority
func(c*Client)GetCertificateAuthority(ctxcontext.Context,req*memorystorepb.GetCertificateAuthorityRequest,opts...gax.CallOption)(*memorystorepb.CertificateAuthority,error)GetCertificateAuthority gets details about the certificate authority for an Instance.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.GetCertificateAuthorityRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#GetCertificateAuthorityRequest.}resp,err:=c.GetCertificateAuthority(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetInstance
func(c*Client)GetInstance(ctxcontext.Context,req*memorystorepb.GetInstanceRequest,opts...gax.CallOption)(*memorystorepb.Instance,error)GetInstance gets details of a single Instance.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.GetInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#GetInstanceRequest.}resp,err:=c.GetInstance(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetLocation
func(c*Client)GetLocation(ctxcontext.Context,req*locationpb.GetLocationRequest,opts...gax.CallOption)(*locationpb.Location,error)GetLocation gets information about a location.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetOperation
func(c*Client)GetOperation(ctxcontext.Context,req*longrunningpb.GetOperationRequest,opts...gax.CallOption)(*longrunningpb.Operation,error)GetOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memorystore"cloud.google.com/go/memorystore/apiv1")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) ListBackupCollections
func(c*Client)ListBackupCollections(ctxcontext.Context,req*memorystorepb.ListBackupCollectionsRequest,opts...gax.CallOption)*BackupCollectionIteratorListBackupCollections lists all backup collections owned by a consumer project in either thespecified location (region) or all locations.
If location_id is specified as - (wildcard), then all regionsavailable to the project are queried, and the results are aggregated.
Examples
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb""google.golang.org/api/iterator")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ListBackupCollectionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListBackupCollectionsRequest.}it:=c.ListBackupCollections(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*memorystorepb.ListBackupCollectionsResponse)}}all
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ListBackupCollectionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListBackupCollectionsRequest.}forresp,err:=rangec.ListBackupCollections(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListBackups
func(c*Client)ListBackups(ctxcontext.Context,req*memorystorepb.ListBackupsRequest,opts...gax.CallOption)*BackupIteratorListBackups lists all backups owned by a backup collection.
Examples
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb""google.golang.org/api/iterator")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ListBackupsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListBackupsRequest.}it:=c.ListBackups(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*memorystorepb.ListBackupsResponse)}}all
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ListBackupsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListBackupsRequest.}forresp,err:=rangec.ListBackups(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListInstances
func(c*Client)ListInstances(ctxcontext.Context,req*memorystorepb.ListInstancesRequest,opts...gax.CallOption)*InstanceIteratorListInstances lists Instances in a given project and location.
Examples
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb""google.golang.org/api/iterator")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListInstancesRequest.}it:=c.ListInstances(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*memorystorepb.ListInstancesResponse)}}all
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListInstancesRequest.}forresp,err:=rangec.ListInstances(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListLocations
func(c*Client)ListLocations(ctxcontext.Context,req*locationpb.ListLocationsRequest,opts...gax.CallOption)*LocationIteratorListLocations lists information about the supported locations for this service.
Examples
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1""google.golang.org/api/iterator"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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()iferr==iterator.Done{break}iferr!=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)}}all
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}forresp,err:=rangec.ListLocations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListOperations
func(c*Client)ListOperations(ctxcontext.Context,req*longrunningpb.ListOperationsRequest,opts...gax.CallOption)*OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memorystore"cloud.google.com/go/memorystore/apiv1""google.golang.org/api/iterator")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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()iferr==iterator.Done{break}iferr!=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)}}all
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memorystore"cloud.google.com/go/memorystore/apiv1")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}forresp,err:=rangec.ListOperations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) RescheduleMaintenance
func(c*Client)RescheduleMaintenance(ctxcontext.Context,req*memorystorepb.RescheduleMaintenanceRequest,opts...gax.CallOption)(*RescheduleMaintenanceOperation,error)RescheduleMaintenance reschedules upcoming maintenance event.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.RescheduleMaintenanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#RescheduleMaintenanceRequest.}op,err:=c.RescheduleMaintenance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) RescheduleMaintenanceOperation
func(c*Client)RescheduleMaintenanceOperation(namestring)*RescheduleMaintenanceOperationRescheduleMaintenanceOperation returns a new RescheduleMaintenanceOperation from a given name.The name must be that of a previously created RescheduleMaintenanceOperation, possibly from a different process.
func (*Client) UpdateInstance
func(c*Client)UpdateInstance(ctxcontext.Context,req*memorystorepb.UpdateInstanceRequest,opts...gax.CallOption)(*UpdateInstanceOperation,error)UpdateInstance updates the parameters of a single Instance.
Example
packagemainimport("context"memorystore"cloud.google.com/go/memorystore/apiv1"memorystorepb"cloud.google.com/go/memorystore/apiv1/memorystorepb")funcmain(){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:=memorystore.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memorystorepb.UpdateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#UpdateInstanceRequest.}op,err:=c.UpdateInstance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) UpdateInstanceOperation
func(c*Client)UpdateInstanceOperation(namestring)*UpdateInstanceOperationUpdateInstanceOperation returns a new UpdateInstanceOperation from a given name.The name must be that of a previously created UpdateInstanceOperation, possibly from a different process.
CreateInstanceOperation
typeCreateInstanceOperationstruct{// contains filtered or unexported fields}CreateInstanceOperation manages a long-running operation from CreateInstance.
func (*CreateInstanceOperation) Done
func(op*CreateInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateInstanceOperation) Metadata
func(op*CreateInstanceOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*CreateInstanceOperation) Name
func(op*CreateInstanceOperation)Name()stringName 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
func(op*CreateInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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 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
func(op*CreateInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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.
DeleteBackupOperation
typeDeleteBackupOperationstruct{// contains filtered or unexported fields}DeleteBackupOperation manages a long-running operation from DeleteBackup.
func (*DeleteBackupOperation) Done
func(op*DeleteBackupOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteBackupOperation) Metadata
func(op*DeleteBackupOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*DeleteBackupOperation) Name
func(op*DeleteBackupOperation)Name()stringName 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 (*DeleteBackupOperation) Poll
func(op*DeleteBackupOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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 (*DeleteBackupOperation) Wait
func(op*DeleteBackupOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteInstanceOperation
typeDeleteInstanceOperationstruct{// contains filtered or unexported fields}DeleteInstanceOperation manages a long-running operation from DeleteInstance.
func (*DeleteInstanceOperation) Done
func(op*DeleteInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteInstanceOperation) Metadata
func(op*DeleteInstanceOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*DeleteInstanceOperation) Name
func(op*DeleteInstanceOperation)Name()stringName 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
func(op*DeleteInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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
func(op*DeleteInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
ExportBackupOperation
typeExportBackupOperationstruct{// contains filtered or unexported fields}ExportBackupOperation manages a long-running operation from ExportBackup.
func (*ExportBackupOperation) Done
func(op*ExportBackupOperation)Done()boolDone reports whether the long-running operation has completed.
func (*ExportBackupOperation) Metadata
func(op*ExportBackupOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*ExportBackupOperation) Name
func(op*ExportBackupOperation)Name()stringName 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 (*ExportBackupOperation) Poll
func(op*ExportBackupOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.Backup,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 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 (*ExportBackupOperation) Wait
func(op*ExportBackupOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.Backup,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.
InstanceIterator
typeInstanceIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*memorystorepb.Instance,nextPageTokenstring,errerror)// contains filtered or unexported fields}InstanceIterator manages a stream of *memorystorepb.Instance.
func (*InstanceIterator) All
func(it*InstanceIterator)All()iter.Seq2[*memorystorepb.Instance,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*InstanceIterator) Next
func(it*InstanceIterator)Next()(*memorystorepb.Instance,error)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.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
LocationIterator
typeLocationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*locationpb.Location,nextPageTokenstring,errerror)// contains filtered or unexported fields}LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func(it*LocationIterator)All()iter.Seq2[*locationpb.Location,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*LocationIterator) Next
func(it*LocationIterator)Next()(*locationpb.Location,error)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.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
OperationIterator
typeOperationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*longrunningpb.Operation,nextPageTokenstring,errerror)// contains filtered or unexported fields}OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All
func(it*OperationIterator)All()iter.Seq2[*longrunningpb.Operation,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*OperationIterator) Next
func(it*OperationIterator)Next()(*longrunningpb.Operation,error)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.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
RescheduleMaintenanceOperation
typeRescheduleMaintenanceOperationstruct{// contains filtered or unexported fields}RescheduleMaintenanceOperation manages a long-running operation from RescheduleMaintenance.
func (*RescheduleMaintenanceOperation) Done
func(op*RescheduleMaintenanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*RescheduleMaintenanceOperation) Metadata
func(op*RescheduleMaintenanceOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*RescheduleMaintenanceOperation) Name
func(op*RescheduleMaintenanceOperation)Name()stringName 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 (*RescheduleMaintenanceOperation) Poll
func(op*RescheduleMaintenanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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 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 (*RescheduleMaintenanceOperation) Wait
func(op*RescheduleMaintenanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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.
UpdateInstanceOperation
typeUpdateInstanceOperationstruct{// contains filtered or unexported fields}UpdateInstanceOperation manages a long-running operation from UpdateInstance.
func (*UpdateInstanceOperation) Done
func(op*UpdateInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateInstanceOperation) Metadata
func(op*UpdateInstanceOperation)Metadata()(*memorystorepb.OperationMetadata,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 (*UpdateInstanceOperation) Name
func(op*UpdateInstanceOperation)Name()stringName 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
func(op*UpdateInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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 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
func(op*UpdateInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memorystorepb.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.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.