Documentation
¶
Overview ¶
Package memorystore is an auto-generated package for the Memorystore API.
General documentation ¶
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page 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@latest
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_Options
c, err := memorystore.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 := &memorystorepb.AddAuthTokenRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#AddAuthTokenRequest.
}
op, err := c.AddAuthToken(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 and for 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 ¶
- func DefaultAuthScopes() []string
- type AddAuthTokenOperation
- func (op *AddAuthTokenOperation) Done() bool
- func (op *AddAuthTokenOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *AddAuthTokenOperation) Name() string
- func (op *AddAuthTokenOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.TokenAuthUser, error)
- func (op *AddAuthTokenOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.TokenAuthUser, error)
- type AddTokenAuthUserOperation
- func (op *AddTokenAuthUserOperation) Done() bool
- func (op *AddTokenAuthUserOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *AddTokenAuthUserOperation) Name() string
- func (op *AddTokenAuthUserOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *AddTokenAuthUserOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- type AuthTokenIterator
- type BackupCollectionIterator
- type BackupInstanceOperation
- func (op *BackupInstanceOperation) Done() bool
- func (op *BackupInstanceOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *BackupInstanceOperation) Name() string
- func (op *BackupInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *BackupInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- type BackupIterator
- type CallOptions
- type Client
- func (c *Client) AddAuthToken(ctx context.Context, req *memorystorepb.AddAuthTokenRequest, ...) (*AddAuthTokenOperation, error)
- func (c *Client) AddAuthTokenOperation(name string) *AddAuthTokenOperation
- func (c *Client) AddTokenAuthUser(ctx context.Context, req *memorystorepb.AddTokenAuthUserRequest, ...) (*AddTokenAuthUserOperation, error)
- func (c *Client) AddTokenAuthUserOperation(name string) *AddTokenAuthUserOperation
- func (c *Client) BackupInstance(ctx context.Context, req *memorystorepb.BackupInstanceRequest, ...) (*BackupInstanceOperation, error)
- func (c *Client) BackupInstanceOperation(name string) *BackupInstanceOperation
- func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateInstance(ctx context.Context, req *memorystorepb.CreateInstanceRequest, ...) (*CreateInstanceOperation, error)
- func (c *Client) CreateInstanceOperation(name string) *CreateInstanceOperation
- func (c *Client) DeleteAuthToken(ctx context.Context, req *memorystorepb.DeleteAuthTokenRequest, ...) (*DeleteAuthTokenOperation, error)
- func (c *Client) DeleteAuthTokenOperation(name string) *DeleteAuthTokenOperation
- func (c *Client) DeleteBackup(ctx context.Context, req *memorystorepb.DeleteBackupRequest, ...) (*DeleteBackupOperation, error)
- func (c *Client) DeleteBackupOperation(name string) *DeleteBackupOperation
- func (c *Client) DeleteInstance(ctx context.Context, req *memorystorepb.DeleteInstanceRequest, ...) (*DeleteInstanceOperation, error)
- func (c *Client) DeleteInstanceOperation(name string) *DeleteInstanceOperation
- func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *Client) DeleteTokenAuthUser(ctx context.Context, req *memorystorepb.DeleteTokenAuthUserRequest, ...) (*DeleteTokenAuthUserOperation, error)
- func (c *Client) DeleteTokenAuthUserOperation(name string) *DeleteTokenAuthUserOperation
- func (c *Client) ExportBackup(ctx context.Context, req *memorystorepb.ExportBackupRequest, ...) (*ExportBackupOperation, error)
- func (c *Client) ExportBackupOperation(name string) *ExportBackupOperation
- func (c *Client) FinishMigration(ctx context.Context, req *memorystorepb.FinishMigrationRequest, ...) (*FinishMigrationOperation, error)
- func (c *Client) FinishMigrationOperation(name string) *FinishMigrationOperation
- func (c *Client) GetAuthToken(ctx context.Context, req *memorystorepb.GetAuthTokenRequest, ...) (*memorystorepb.AuthToken, error)
- func (c *Client) GetBackup(ctx context.Context, req *memorystorepb.GetBackupRequest, ...) (*memorystorepb.Backup, error)
- func (c *Client) GetBackupCollection(ctx context.Context, req *memorystorepb.GetBackupCollectionRequest, ...) (*memorystorepb.BackupCollection, error)
- func (c *Client) GetCertificateAuthority(ctx context.Context, req *memorystorepb.GetCertificateAuthorityRequest, ...) (*memorystorepb.CertificateAuthority, error)
- func (c *Client) GetInstance(ctx context.Context, req *memorystorepb.GetInstanceRequest, ...) (*memorystorepb.Instance, error)
- func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *Client) GetSharedRegionalCertificateAuthority(ctx context.Context, ...) (*memorystorepb.SharedRegionalCertificateAuthority, error)
- func (c *Client) GetTokenAuthUser(ctx context.Context, req *memorystorepb.GetTokenAuthUserRequest, ...) (*memorystorepb.TokenAuthUser, error)
- func (c *Client) ListAuthTokens(ctx context.Context, req *memorystorepb.ListAuthTokensRequest, ...) *AuthTokenIterator
- func (c *Client) ListBackupCollections(ctx context.Context, req *memorystorepb.ListBackupCollectionsRequest, ...) *BackupCollectionIterator
- func (c *Client) ListBackups(ctx context.Context, req *memorystorepb.ListBackupsRequest, ...) *BackupIterator
- func (c *Client) ListInstances(ctx context.Context, req *memorystorepb.ListInstancesRequest, ...) *InstanceIterator
- func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *Client) ListTokenAuthUsers(ctx context.Context, req *memorystorepb.ListTokenAuthUsersRequest, ...) *TokenAuthUserIterator
- func (c *Client) RescheduleMaintenance(ctx context.Context, req *memorystorepb.RescheduleMaintenanceRequest, ...) (*RescheduleMaintenanceOperation, error)
- func (c *Client) RescheduleMaintenanceOperation(name string) *RescheduleMaintenanceOperation
- func (c *Client) StartMigration(ctx context.Context, req *memorystorepb.StartMigrationRequest, ...) (*StartMigrationOperation, error)
- func (c *Client) StartMigrationOperation(name string) *StartMigrationOperation
- func (c *Client) UpdateInstance(ctx context.Context, req *memorystorepb.UpdateInstanceRequest, ...) (*UpdateInstanceOperation, error)
- func (c *Client) UpdateInstanceOperation(name string) *UpdateInstanceOperation
- type CreateInstanceOperation
- func (op *CreateInstanceOperation) Done() bool
- func (op *CreateInstanceOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *CreateInstanceOperation) Name() string
- func (op *CreateInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *CreateInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- type DeleteAuthTokenOperation
- func (op *DeleteAuthTokenOperation) Done() bool
- func (op *DeleteAuthTokenOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *DeleteAuthTokenOperation) Name() string
- func (op *DeleteAuthTokenOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAuthTokenOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteBackupOperation
- func (op *DeleteBackupOperation) Done() bool
- func (op *DeleteBackupOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *DeleteBackupOperation) Name() string
- func (op *DeleteBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteInstanceOperation
- func (op *DeleteInstanceOperation) Done() bool
- func (op *DeleteInstanceOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *DeleteInstanceOperation) Name() string
- func (op *DeleteInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteTokenAuthUserOperation
- func (op *DeleteTokenAuthUserOperation) Done() bool
- func (op *DeleteTokenAuthUserOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *DeleteTokenAuthUserOperation) Name() string
- func (op *DeleteTokenAuthUserOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteTokenAuthUserOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type ExportBackupOperation
- func (op *ExportBackupOperation) Done() bool
- func (op *ExportBackupOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *ExportBackupOperation) Name() string
- func (op *ExportBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Backup, error)
- func (op *ExportBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Backup, error)
- type FinishMigrationOperation
- func (op *FinishMigrationOperation) Done() bool
- func (op *FinishMigrationOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *FinishMigrationOperation) Name() string
- func (op *FinishMigrationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *FinishMigrationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- type InstanceIterator
- type LocationIterator
- type OperationIterator
- type RescheduleMaintenanceOperation
- func (op *RescheduleMaintenanceOperation) Done() bool
- func (op *RescheduleMaintenanceOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *RescheduleMaintenanceOperation) Name() string
- func (op *RescheduleMaintenanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *RescheduleMaintenanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- type StartMigrationOperation
- func (op *StartMigrationOperation) Done() bool
- func (op *StartMigrationOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *StartMigrationOperation) Name() string
- func (op *StartMigrationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *StartMigrationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- type TokenAuthUserIterator
- type UpdateInstanceOperation
- func (op *UpdateInstanceOperation) Done() bool
- func (op *UpdateInstanceOperation) Metadata() (*memorystorepb.OperationMetadata, error)
- func (op *UpdateInstanceOperation) Name() string
- func (op *UpdateInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
- func (op *UpdateInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.Instance, error)
Examples ¶
- Client.AddAuthToken
- Client.AddTokenAuthUser
- Client.BackupInstance
- Client.CancelOperation
- Client.CreateInstance
- Client.DeleteAuthToken
- Client.DeleteBackup
- Client.DeleteInstance
- Client.DeleteOperation
- Client.DeleteTokenAuthUser
- Client.ExportBackup
- Client.FinishMigration
- Client.GetAuthToken
- Client.GetBackup
- Client.GetBackupCollection
- Client.GetCertificateAuthority
- Client.GetInstance
- Client.GetLocation
- Client.GetOperation
- Client.GetSharedRegionalCertificateAuthority
- Client.GetTokenAuthUser
- Client.ListAuthTokens
- Client.ListAuthTokens (All)
- Client.ListBackupCollections
- Client.ListBackupCollections (All)
- Client.ListBackups
- Client.ListBackups (All)
- Client.ListInstances
- Client.ListInstances (All)
- Client.ListLocations
- Client.ListLocations (All)
- Client.ListOperations
- Client.ListOperations (All)
- Client.ListTokenAuthUsers
- Client.ListTokenAuthUsers (All)
- Client.RescheduleMaintenance
- Client.StartMigration
- Client.UpdateInstance
- NewClient
- NewRESTClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type AddAuthTokenOperation ¶ added in v1.3.0
type AddAuthTokenOperation struct {
// contains filtered or unexported fields
}
AddAuthTokenOperation manages a long-running operation from AddAuthToken.
func (*AddAuthTokenOperation) Done ¶ added in v1.3.0
func (op *AddAuthTokenOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*AddAuthTokenOperation) Metadata ¶ added in v1.3.0
func (op *AddAuthTokenOperation) 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 (*AddAuthTokenOperation) Name ¶ added in v1.3.0
func (op *AddAuthTokenOperation) 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 (*AddAuthTokenOperation) Poll ¶ added in v1.3.0
func (op *AddAuthTokenOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.TokenAuthUser, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*AddAuthTokenOperation) Wait ¶ added in v1.3.0
func (op *AddAuthTokenOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*memorystorepb.TokenAuthUser, 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.
type AddTokenAuthUserOperation ¶ added in v1.3.0
type AddTokenAuthUserOperation struct {
// contains filtered or unexported fields
}
AddTokenAuthUserOperation manages a long-running operation from AddTokenAuthUser.
func (*AddTokenAuthUserOperation) Done ¶ added in v1.3.0
func (op *AddTokenAuthUserOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*AddTokenAuthUserOperation) Metadata ¶ added in v1.3.0
func (op *AddTokenAuthUserOperation) 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 (*AddTokenAuthUserOperation) Name ¶ added in v1.3.0
func (op *AddTokenAuthUserOperation) 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 (*AddTokenAuthUserOperation) Poll ¶ added in v1.3.0
func (op *AddTokenAuthUserOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*AddTokenAuthUserOperation) Wait ¶ added in v1.3.0
func (op *AddTokenAuthUserOperation) Wait(ctx context.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.
type AuthTokenIterator ¶ added in v1.3.0
type AuthTokenIterator 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(pageSize int, pageToken string) (results []*memorystorepb.AuthToken, nextPageToken string, err error)
// contains filtered or unexported fields
}
AuthTokenIterator manages a stream of *memorystorepb.AuthToken.
func (*AuthTokenIterator) All ¶ added in v1.3.0
func (it *AuthTokenIterator) All() iter.Seq2[*memorystorepb.AuthToken, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AuthTokenIterator) Next ¶ added in v1.3.0
func (it *AuthTokenIterator) Next() (*memorystorepb.AuthToken, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*AuthTokenIterator) PageInfo ¶ added in v1.3.0
func (it *AuthTokenIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BackupCollectionIterator ¶ added in v0.3.0
type BackupCollectionIterator 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(pageSize int, pageToken string) (results []*memorystorepb.BackupCollection, nextPageToken string, err error)
// contains filtered or unexported fields
}
BackupCollectionIterator manages a stream of *memorystorepb.BackupCollection.
func (*BackupCollectionIterator) All ¶ added in v0.3.0
func (it *BackupCollectionIterator) All() iter.Seq2[*memorystorepb.BackupCollection, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupCollectionIterator) Next ¶ added in v0.3.0
func (it *BackupCollectionIterator) Next() (*memorystorepb.BackupCollection, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*BackupCollectionIterator) PageInfo ¶ added in v0.3.0
func (it *BackupCollectionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BackupInstanceOperation ¶ added in v0.3.0
type BackupInstanceOperation struct {
// contains filtered or unexported fields
}
BackupInstanceOperation manages a long-running operation from BackupInstance.
func (*BackupInstanceOperation) Done ¶ added in v0.3.0
func (op *BackupInstanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*BackupInstanceOperation) Metadata ¶ added in v0.3.0
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 ¶ added in v0.3.0
func (op *BackupInstanceOperation) 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 (*BackupInstanceOperation) Poll ¶ added in v0.3.0
func (op *BackupInstanceOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*BackupInstanceOperation) Wait ¶ added in v0.3.0
func (op *BackupInstanceOperation) Wait(ctx context.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.
type BackupIterator ¶ added in v0.3.0
type BackupIterator 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(pageSize int, pageToken string) (results []*memorystorepb.Backup, nextPageToken string, err error)
// contains filtered or unexported fields
}
BackupIterator manages a stream of *memorystorepb.Backup.
func (*BackupIterator) All ¶ added in v0.3.0
func (it *BackupIterator) All() iter.Seq2[*memorystorepb.Backup, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupIterator) Next ¶ added in v0.3.0
func (it *BackupIterator) Next() (*memorystorepb.Backup, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*BackupIterator) PageInfo ¶ added in v0.3.0
func (it *BackupIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CallOptions ¶
type CallOptions struct {
ListInstances []gax.CallOption
GetInstance []gax.CallOption
CreateInstance []gax.CallOption
UpdateInstance []gax.CallOption
DeleteInstance []gax.CallOption
GetCertificateAuthority []gax.CallOption
RescheduleMaintenance []gax.CallOption
ListBackupCollections []gax.CallOption
GetBackupCollection []gax.CallOption
ListBackups []gax.CallOption
GetBackup []gax.CallOption
DeleteBackup []gax.CallOption
ExportBackup []gax.CallOption
BackupInstance []gax.CallOption
StartMigration []gax.CallOption
FinishMigration []gax.CallOption
ListTokenAuthUsers []gax.CallOption
GetTokenAuthUser []gax.CallOption
ListAuthTokens []gax.CallOption
GetAuthToken []gax.CallOption
AddTokenAuthUser []gax.CallOption
DeleteTokenAuthUser []gax.CallOption
AddAuthToken []gax.CallOption
DeleteAuthToken []gax.CallOption
GetLocation []gax.CallOption
ListLocations []gax.CallOption
CancelOperation []gax.CallOption
DeleteOperation []gax.CallOption
GetOperation []gax.CallOption
ListOperations []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
type Client ¶
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 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 NewClient ¶ added in v0.9.0
NewClient creates a new memorystore 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 resources
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
Output:
func NewRESTClient ¶
NewRESTClient creates a new memorystore rest client.
Service describing handlers for resources
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.NewRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
Output:
func (*Client) AddAuthToken ¶ added in v1.3.0
func (c *Client) AddAuthToken(ctx context.Context, req *memorystorepb.AddAuthTokenRequest, opts ...gax.CallOption) (*AddAuthTokenOperation, error)
AddAuthToken adds a token for a user of a token based auth enabled instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.AddAuthTokenRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#AddAuthTokenRequest.
}
op, err := c.AddAuthToken(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) AddAuthTokenOperation ¶ added in v1.3.0
func (c *Client) AddAuthTokenOperation(name string) *AddAuthTokenOperation
AddAuthTokenOperation returns a new AddAuthTokenOperation from a given name. The name must be that of a previously created AddAuthTokenOperation, possibly from a different process.
func (*Client) AddTokenAuthUser ¶ added in v1.3.0
func (c *Client) AddTokenAuthUser(ctx context.Context, req *memorystorepb.AddTokenAuthUserRequest, opts ...gax.CallOption) (*AddTokenAuthUserOperation, error)
AddTokenAuthUser adds a token auth user for a token based auth enabled instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.AddTokenAuthUserRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#AddTokenAuthUserRequest.
}
op, err := c.AddTokenAuthUser(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) AddTokenAuthUserOperation ¶ added in v1.3.0
func (c *Client) AddTokenAuthUserOperation(name string) *AddTokenAuthUserOperation
AddTokenAuthUserOperation returns a new AddTokenAuthUserOperation from a given name. The name must be that of a previously created AddTokenAuthUserOperation, possibly from a different process.
func (*Client) BackupInstance ¶ added in v0.3.0
func (c *Client) BackupInstance(ctx context.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 collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance’s internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) BackupInstanceOperation ¶ added in v0.3.0
func (c *Client) BackupInstanceOperation(name string) *BackupInstanceOperation
BackupInstanceOperation 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(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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.
}
}
Output:
func (*Client) Close ¶
Close closes the connection to the API service. **Always** call Close() when the client is no longer required.
func (*Client) Connection
deprecated
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateInstance ¶
func (c *Client) CreateInstance(ctx context.Context, req *memorystorepb.CreateInstanceRequest, opts ...gax.CallOption) (*CreateInstanceOperation, error)
CreateInstance creates a new Instance in a given project and location.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) CreateInstanceOperation ¶
func (c *Client) CreateInstanceOperation(name string) *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) DeleteAuthToken ¶ added in v1.3.0
func (c *Client) DeleteAuthToken(ctx context.Context, req *memorystorepb.DeleteAuthTokenRequest, opts ...gax.CallOption) (*DeleteAuthTokenOperation, error)
DeleteAuthToken deletes a token for a user of a token based auth enabled instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.DeleteAuthTokenRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#DeleteAuthTokenRequest.
}
op, err := c.DeleteAuthToken(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
Output:
func (*Client) DeleteAuthTokenOperation ¶ added in v1.3.0
func (c *Client) DeleteAuthTokenOperation(name string) *DeleteAuthTokenOperation
DeleteAuthTokenOperation returns a new DeleteAuthTokenOperation from a given name. The name must be that of a previously created DeleteAuthTokenOperation, possibly from a different process.
func (*Client) DeleteBackup ¶ added in v0.3.0
func (c *Client) DeleteBackup(ctx context.Context, req *memorystorepb.DeleteBackupRequest, opts ...gax.CallOption) (*DeleteBackupOperation, error)
DeleteBackup deletes a specific backup.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
Output:
func (*Client) DeleteBackupOperation ¶ added in v0.3.0
func (c *Client) DeleteBackupOperation(name string) *DeleteBackupOperation
DeleteBackupOperation 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(ctx context.Context, req *memorystorepb.DeleteInstanceRequest, opts ...gax.CallOption) (*DeleteInstanceOperation, error)
DeleteInstance deletes a single Instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
Output:
func (*Client) DeleteInstanceOperation ¶
func (c *Client) DeleteInstanceOperation(name string) *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(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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.
}
}
Output:
func (*Client) DeleteTokenAuthUser ¶ added in v1.3.0
func (c *Client) DeleteTokenAuthUser(ctx context.Context, req *memorystorepb.DeleteTokenAuthUserRequest, opts ...gax.CallOption) (*DeleteTokenAuthUserOperation, error)
DeleteTokenAuthUser deletes a token auth user for a token based auth enabled instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.DeleteTokenAuthUserRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#DeleteTokenAuthUserRequest.
}
op, err := c.DeleteTokenAuthUser(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
Output:
func (*Client) DeleteTokenAuthUserOperation ¶ added in v1.3.0
func (c *Client) DeleteTokenAuthUserOperation(name string) *DeleteTokenAuthUserOperation
DeleteTokenAuthUserOperation returns a new DeleteTokenAuthUserOperation from a given name. The name must be that of a previously created DeleteTokenAuthUserOperation, possibly from a different process.
func (*Client) ExportBackup ¶ added in v0.3.0
func (c *Client) ExportBackup(ctx context.Context, req *memorystorepb.ExportBackupRequest, opts ...gax.CallOption) (*ExportBackupOperation, error)
ExportBackup exports a specific backup to a customer target Cloud Storage URI.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) ExportBackupOperation ¶ added in v0.3.0
func (c *Client) ExportBackupOperation(name string) *ExportBackupOperation
ExportBackupOperation 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) FinishMigration ¶ added in v1.1.0
func (c *Client) FinishMigration(ctx context.Context, req *memorystorepb.FinishMigrationRequest, opts ...gax.CallOption) (*FinishMigrationOperation, error)
FinishMigration finalizes the migration process.
After the successful completion of this operation, the target instance will:
Stop replicating from the source instance.
Allow both reads and writes.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.FinishMigrationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#FinishMigrationRequest.
}
op, err := c.FinishMigration(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) FinishMigrationOperation ¶ added in v1.1.0
func (c *Client) FinishMigrationOperation(name string) *FinishMigrationOperation
FinishMigrationOperation returns a new FinishMigrationOperation from a given name. The name must be that of a previously created FinishMigrationOperation, possibly from a different process.
func (*Client) GetAuthToken ¶ added in v1.3.0
func (c *Client) GetAuthToken(ctx context.Context, req *memorystorepb.GetAuthTokenRequest, opts ...gax.CallOption) (*memorystorepb.AuthToken, error)
GetAuthToken gets a token based auth enabled instance’s auth token for a given user.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.GetAuthTokenRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#GetAuthTokenRequest.
}
resp, err := c.GetAuthToken(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) GetBackup ¶ added in v0.3.0
func (c *Client) GetBackup(ctx context.Context, req *memorystorepb.GetBackupRequest, opts ...gax.CallOption) (*memorystorepb.Backup, error)
GetBackup gets the details of a specific backup.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) GetBackupCollection ¶ added in v0.3.0
func (c *Client) GetBackupCollection(ctx context.Context, req *memorystorepb.GetBackupCollectionRequest, opts ...gax.CallOption) (*memorystorepb.BackupCollection, error)
GetBackupCollection get a backup collection.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) GetCertificateAuthority ¶
func (c *Client) GetCertificateAuthority(ctx context.Context, req *memorystorepb.GetCertificateAuthorityRequest, opts ...gax.CallOption) (*memorystorepb.CertificateAuthority, error)
GetCertificateAuthority gets details about the certificate authority for an Instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) GetInstance ¶
func (c *Client) GetInstance(ctx context.Context, req *memorystorepb.GetInstanceRequest, opts ...gax.CallOption) (*memorystorepb.Instance, error)
GetInstance gets details of a single Instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) GetLocation ¶
func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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
}
Output:
func (*Client) GetOperation ¶
func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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
}
Output:
func (*Client) GetSharedRegionalCertificateAuthority ¶ added in v0.5.0
func (c *Client) GetSharedRegionalCertificateAuthority(ctx context.Context, req *memorystorepb.GetSharedRegionalCertificateAuthorityRequest, opts ...gax.CallOption) (*memorystorepb.SharedRegionalCertificateAuthority, error)
GetSharedRegionalCertificateAuthority gets the details of shared regional certificate authority information for Memorystore instance.
func (*Client) GetTokenAuthUser ¶ added in v1.3.0
func (c *Client) GetTokenAuthUser(ctx context.Context, req *memorystorepb.GetTokenAuthUserRequest, opts ...gax.CallOption) (*memorystorepb.TokenAuthUser, error)
GetTokenAuthUser gets a specific token auth user for a token based auth enabled instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.GetTokenAuthUserRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#GetTokenAuthUserRequest.
}
resp, err := c.GetTokenAuthUser(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) ListAuthTokens ¶ added in v1.3.0
func (c *Client) ListAuthTokens(ctx context.Context, req *memorystorepb.ListAuthTokensRequest, opts ...gax.CallOption) *AuthTokenIterator
ListAuthTokens lists all the auth tokens for a specific token auth user.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
"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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListAuthTokensRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListAuthTokensRequest.
}
it := c.ListAuthTokens(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.(*memorystorepb.ListAuthTokensResponse)
}
}
Output:
Example (All) ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListAuthTokensRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListAuthTokensRequest.
}
for resp, err := range c.ListAuthTokens(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
Output:
func (*Client) ListBackupCollections ¶ added in v0.3.0
func (c *Client) ListBackupCollections(ctx context.Context, req *memorystorepb.ListBackupCollectionsRequest, opts ...gax.CallOption) *BackupCollectionIterator
ListBackupCollections lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
"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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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()
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.(*memorystorepb.ListBackupCollectionsResponse)
}
}
Output:
Example (All) ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListBackupCollectionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListBackupCollectionsRequest.
}
for resp, err := range c.ListBackupCollections(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
Output:
func (*Client) ListBackups ¶ added in v0.3.0
func (c *Client) ListBackups(ctx context.Context, req *memorystorepb.ListBackupsRequest, opts ...gax.CallOption) *BackupIterator
ListBackups lists all backups owned by a backup collection.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
"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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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()
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.(*memorystorepb.ListBackupsResponse)
}
}
Output:
Example (All) ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListBackupsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListBackupsRequest.
}
for resp, err := range c.ListBackups(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
Output:
func (*Client) ListInstances ¶
func (c *Client) ListInstances(ctx context.Context, req *memorystorepb.ListInstancesRequest, opts ...gax.CallOption) *InstanceIterator
ListInstances lists Instances in a given project and location.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
"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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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()
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.(*memorystorepb.ListInstancesResponse)
}
}
Output:
Example (All) ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListInstancesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#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
}
}
Output:
func (*Client) ListLocations ¶
func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
This method lists locations based on the resource scope provided in the [ListLocationsRequest.name (at http://ListLocationsRequest.name)][google.cloud.location.ListLocationsRequest.name (at http://google.cloud.location.ListLocationsRequest.name)] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.
For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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)
}
}
Output:
Example (All) ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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
}
}
Output:
func (*Client) ListOperations ¶
func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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)
}
}
Output:
Example (All) ¶
package main
import (
"context"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
memorystore "cloud.google.com/go/memorystore/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_Options
c, err := memorystore.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
}
}
Output:
func (*Client) ListTokenAuthUsers ¶ added in v1.3.0
func (c *Client) ListTokenAuthUsers(ctx context.Context, req *memorystorepb.ListTokenAuthUsersRequest, opts ...gax.CallOption) *TokenAuthUserIterator
ListTokenAuthUsers lists all the token auth users for a token based auth enabled instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
"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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListTokenAuthUsersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListTokenAuthUsersRequest.
}
it := c.ListTokenAuthUsers(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.(*memorystorepb.ListTokenAuthUsersResponse)
}
}
Output:
Example (All) ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.ListTokenAuthUsersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#ListTokenAuthUsersRequest.
}
for resp, err := range c.ListTokenAuthUsers(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
Output:
func (*Client) RescheduleMaintenance ¶ added in v0.3.0
func (c *Client) RescheduleMaintenance(ctx context.Context, req *memorystorepb.RescheduleMaintenanceRequest, opts ...gax.CallOption) (*RescheduleMaintenanceOperation, error)
RescheduleMaintenance reschedules upcoming maintenance event.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) RescheduleMaintenanceOperation ¶ added in v0.3.0
func (c *Client) RescheduleMaintenanceOperation(name string) *RescheduleMaintenanceOperation
RescheduleMaintenanceOperation 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) StartMigration ¶ added in v1.1.0
func (c *Client) StartMigration(ctx context.Context, req *memorystorepb.StartMigrationRequest, opts ...gax.CallOption) (*StartMigrationOperation, error)
StartMigration initiates the migration of a source instance to the target Memorystore instance.
After the successful completion of this operation, the target instance will:
Set up replication with the source instance and replicate any writes to the source instance.
Only allow reads.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &memorystorepb.StartMigrationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/memorystore/apiv1/memorystorepb#StartMigrationRequest.
}
op, err := c.StartMigration(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) StartMigrationOperation ¶ added in v1.1.0
func (c *Client) StartMigrationOperation(name string) *StartMigrationOperation
StartMigrationOperation returns a new StartMigrationOperation from a given name. The name must be that of a previously created StartMigrationOperation, possibly from a different process.
func (*Client) UpdateInstance ¶
func (c *Client) UpdateInstance(ctx context.Context, req *memorystorepb.UpdateInstanceRequest, opts ...gax.CallOption) (*UpdateInstanceOperation, error)
UpdateInstance updates the parameters of a single Instance.
Example ¶
package main
import (
"context"
memorystore "cloud.google.com/go/memorystore/apiv1"
memorystorepb "cloud.google.com/go/memorystore/apiv1/memorystorepb"
)
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_Options
c, err := memorystore.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
Output:
func (*Client) UpdateInstanceOperation ¶
func (c *Client) UpdateInstanceOperation(name string) *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.
type CreateInstanceOperation ¶
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 ¶
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() 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 (*CreateInstanceOperation) Poll ¶
func (op *CreateInstanceOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateInstanceOperation) Wait ¶
func (op *CreateInstanceOperation) Wait(ctx context.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.
type DeleteAuthTokenOperation ¶ added in v1.3.0
type DeleteAuthTokenOperation struct {
// contains filtered or unexported fields
}
DeleteAuthTokenOperation manages a long-running operation from DeleteAuthToken.
func (*DeleteAuthTokenOperation) Done ¶ added in v1.3.0
func (op *DeleteAuthTokenOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteAuthTokenOperation) Metadata ¶ added in v1.3.0
func (op *DeleteAuthTokenOperation) 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 (*DeleteAuthTokenOperation) Name ¶ added in v1.3.0
func (op *DeleteAuthTokenOperation) 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 (*DeleteAuthTokenOperation) Poll ¶ added in v1.3.0
func (op *DeleteAuthTokenOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteAuthTokenOperation) Wait ¶ added in v1.3.0
func (op *DeleteAuthTokenOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
type DeleteBackupOperation ¶ added in v0.3.0
type DeleteBackupOperation struct {
// contains filtered or unexported fields
}
DeleteBackupOperation manages a long-running operation from DeleteBackup.
func (*DeleteBackupOperation) Done ¶ added in v0.3.0
func (op *DeleteBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBackupOperation) Metadata ¶ added in v0.3.0
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 ¶ added in v0.3.0
func (op *DeleteBackupOperation) 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 (*DeleteBackupOperation) Poll ¶ added in v0.3.0
func (op *DeleteBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteBackupOperation) Wait ¶ added in v0.3.0
func (op *DeleteBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
type DeleteInstanceOperation ¶
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 ¶
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() 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 (*DeleteInstanceOperation) Poll ¶
func (op *DeleteInstanceOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteInstanceOperation) Wait ¶
func (op *DeleteInstanceOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
type DeleteTokenAuthUserOperation ¶ added in v1.3.0
type DeleteTokenAuthUserOperation struct {
// contains filtered or unexported fields
}
DeleteTokenAuthUserOperation manages a long-running operation from DeleteTokenAuthUser.
func (*DeleteTokenAuthUserOperation) Done ¶ added in v1.3.0
func (op *DeleteTokenAuthUserOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteTokenAuthUserOperation) Metadata ¶ added in v1.3.0
func (op *DeleteTokenAuthUserOperation) 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 (*DeleteTokenAuthUserOperation) Name ¶ added in v1.3.0
func (op *DeleteTokenAuthUserOperation) 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 (*DeleteTokenAuthUserOperation) Poll ¶ added in v1.3.0
func (op *DeleteTokenAuthUserOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteTokenAuthUserOperation) Wait ¶ added in v1.3.0
func (op *DeleteTokenAuthUserOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
type ExportBackupOperation ¶ added in v0.3.0
type ExportBackupOperation struct {
// contains filtered or unexported fields
}
ExportBackupOperation manages a long-running operation from ExportBackup.
func (*ExportBackupOperation) Done ¶ added in v0.3.0
func (op *ExportBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ExportBackupOperation) Metadata ¶ added in v0.3.0
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 ¶ added in v0.3.0
func (op *ExportBackupOperation) 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 (*ExportBackupOperation) Poll ¶ added in v0.3.0
func (op *ExportBackupOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ExportBackupOperation) Wait ¶ added in v0.3.0
func (op *ExportBackupOperation) Wait(ctx context.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.
type FinishMigrationOperation ¶ added in v1.1.0
type FinishMigrationOperation struct {
// contains filtered or unexported fields
}
FinishMigrationOperation manages a long-running operation from FinishMigration.
func (*FinishMigrationOperation) Done ¶ added in v1.1.0
func (op *FinishMigrationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*FinishMigrationOperation) Metadata ¶ added in v1.1.0
func (op *FinishMigrationOperation) 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 (*FinishMigrationOperation) Name ¶ added in v1.1.0
func (op *FinishMigrationOperation) 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 (*FinishMigrationOperation) Poll ¶ added in v1.1.0
func (op *FinishMigrationOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*FinishMigrationOperation) Wait ¶ added in v1.1.0
func (op *FinishMigrationOperation) Wait(ctx context.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.
type InstanceIterator ¶
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(pageSize int, pageToken string) (results []*memorystorepb.Instance, nextPageToken string, err error)
// 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, the iterator 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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*InstanceIterator) PageInfo ¶
func (it *InstanceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type LocationIterator ¶
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(pageSize int, pageToken string) (results []*locationpb.Location, nextPageToken string, err error)
// 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, the iterator 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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo ¶
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type OperationIterator ¶
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(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error)
// 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, the iterator 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 more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo ¶
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RescheduleMaintenanceOperation ¶ added in v0.3.0
type RescheduleMaintenanceOperation struct {
// contains filtered or unexported fields
}
RescheduleMaintenanceOperation manages a long-running operation from RescheduleMaintenance.
func (*RescheduleMaintenanceOperation) Done ¶ added in v0.3.0
func (op *RescheduleMaintenanceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RescheduleMaintenanceOperation) Metadata ¶ added in v0.3.0
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 ¶ added in v0.3.0
func (op *RescheduleMaintenanceOperation) 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 (*RescheduleMaintenanceOperation) Poll ¶ added in v0.3.0
func (op *RescheduleMaintenanceOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*RescheduleMaintenanceOperation) Wait ¶ added in v0.3.0
func (op *RescheduleMaintenanceOperation) Wait(ctx context.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.
type StartMigrationOperation ¶ added in v1.1.0
type StartMigrationOperation struct {
// contains filtered or unexported fields
}
StartMigrationOperation manages a long-running operation from StartMigration.
func (*StartMigrationOperation) Done ¶ added in v1.1.0
func (op *StartMigrationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StartMigrationOperation) Metadata ¶ added in v1.1.0
func (op *StartMigrationOperation) 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 (*StartMigrationOperation) Name ¶ added in v1.1.0
func (op *StartMigrationOperation) 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 (*StartMigrationOperation) Poll ¶ added in v1.1.0
func (op *StartMigrationOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StartMigrationOperation) Wait ¶ added in v1.1.0
func (op *StartMigrationOperation) Wait(ctx context.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.
type TokenAuthUserIterator ¶ added in v1.3.0
type TokenAuthUserIterator 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(pageSize int, pageToken string) (results []*memorystorepb.TokenAuthUser, nextPageToken string, err error)
// contains filtered or unexported fields
}
TokenAuthUserIterator manages a stream of *memorystorepb.TokenAuthUser.
func (*TokenAuthUserIterator) All ¶ added in v1.3.0
func (it *TokenAuthUserIterator) All() iter.Seq2[*memorystorepb.TokenAuthUser, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*TokenAuthUserIterator) Next ¶ added in v1.3.0
func (it *TokenAuthUserIterator) Next() (*memorystorepb.TokenAuthUser, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*TokenAuthUserIterator) PageInfo ¶ added in v1.3.0
func (it *TokenAuthUserIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type UpdateInstanceOperation ¶
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 ¶
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() 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 (*UpdateInstanceOperation) Poll ¶
func (op *UpdateInstanceOperation) Poll(ctx context.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 and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateInstanceOperation) Wait ¶
func (op *UpdateInstanceOperation) Wait(ctx context.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.