Documentation

Overview

Package redis is an auto-generated package for the Google Cloud Memorystore for Redis API.

Creates and manages Redis instances on the Google Cloud Platform.

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.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Index

Examples

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 CloudRedisCallOptions

    type CloudRedisCallOptions struct {
    	ListInstances    []gax.CallOption
    	GetInstance      []gax.CallOption
    	CreateInstance   []gax.CallOption
    	UpdateInstance   []gax.CallOption
    	UpgradeInstance  []gax.CallOption
    	ImportInstance   []gax.CallOption
    	ExportInstance   []gax.CallOption
    	FailoverInstance []gax.CallOption
    	DeleteInstance   []gax.CallOption
    }

      CloudRedisCallOptions contains the retry settings for each method of CloudRedisClient.

      type CloudRedisClient

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

        CloudRedisClient is a client for interacting with Google Cloud Memorystore for Redis API.

        Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

        func NewCloudRedisClient

        func NewCloudRedisClient(ctx context.Context, opts ...option.ClientOption) (*CloudRedisClient, error)

        NewCloudRedisClient creates a new cloud redis client.

        Configures and manages Cloud Memorystore for Redis instances

        Google Cloud Memorystore for Redis v1

        The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

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

        Note that location_id must be referring to a GCP region; for example:

        projects/redpepper-1290/locations/us-central1/instances/my-redis
        
        Example
        Output:
        
        

        func (*CloudRedisClient) Close

        func (c *CloudRedisClient) Close() error

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

          func (*CloudRedisClient) Connection

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

            Connection returns a connection to the API service.

            Deprecated.

            func (*CloudRedisClient) CreateInstance

              CreateInstance creates a Redis instance based on the specified tier and memory size.

              By default, the instance is accessible from the project’s default network (at https://cloud.google.com/vpc/docs/vpc).

              The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

              The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

              Example
              Output:
              
              

              func (*CloudRedisClient) CreateInstanceOperation

              func (c *CloudRedisClient) 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 (*CloudRedisClient) DeleteInstance

                  DeleteInstance deletes a specific Redis instance. Instance stops serving and data is deleted.

                  Example
                  Output:
                  
                  

                  func (*CloudRedisClient) DeleteInstanceOperation

                  func (c *CloudRedisClient) 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 (*CloudRedisClient) ExportInstance

                      ExportInstance export Redis instance data into a Redis RDB format file in Cloud Storage.

                      Redis will continue serving during this operation.

                      The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

                      Example
                      Output:
                      
                      

                      func (*CloudRedisClient) ExportInstanceOperation

                      func (c *CloudRedisClient) ExportInstanceOperation(name string) *ExportInstanceOperation

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

                        func (*CloudRedisClient) FailoverInstance

                          FailoverInstance initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

                          Example
                          Output:
                          
                          

                          func (*CloudRedisClient) FailoverInstanceOperation

                          func (c *CloudRedisClient) FailoverInstanceOperation(name string) *FailoverInstanceOperation

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

                            func (*CloudRedisClient) GetInstance

                              GetInstance gets the details of a specific Redis instance.

                              Example
                              Output:
                              
                              

                              func (*CloudRedisClient) ImportInstance

                                ImportInstance import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

                                Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.

                                The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

                                Example
                                Output:
                                
                                

                                func (*CloudRedisClient) ImportInstanceOperation

                                func (c *CloudRedisClient) ImportInstanceOperation(name string) *ImportInstanceOperation

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

                                  func (*CloudRedisClient) ListInstances

                                    ListInstances lists all Redis instances owned by a project in either the specified location (region) or all locations.

                                    The location should have the following format:

                                    projects/{project_id}/locations/{location_id}
                                    

                                    If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

                                    Example
                                    Output:
                                    
                                    

                                    func (*CloudRedisClient) UpdateInstance

                                      UpdateInstance updates the metadata and configuration of a specific Redis instance.

                                      Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

                                      Example
                                      Output:
                                      
                                      

                                      func (*CloudRedisClient) UpdateInstanceOperation

                                      func (c *CloudRedisClient) 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.

                                        func (*CloudRedisClient) UpgradeInstance

                                          UpgradeInstance upgrades Redis instance to the newer Redis version specified in the request.

                                          Example
                                          Output:
                                          
                                          

                                          func (*CloudRedisClient) UpgradeInstanceOperation

                                          func (c *CloudRedisClient) UpgradeInstanceOperation(name string) *UpgradeInstanceOperation

                                            UpgradeInstanceOperation returns a new UpgradeInstanceOperation from a given name. The name must be that of a previously created UpgradeInstanceOperation, 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

                                                  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

                                                      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

                                                        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

                                                              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 ExportInstanceOperation

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

                                                                      ExportInstanceOperation manages a long-running operation from ExportInstance.

                                                                      func (*ExportInstanceOperation) Done

                                                                      func (op *ExportInstanceOperation) Done() bool

                                                                        Done reports whether the long-running operation has completed.

                                                                        func (*ExportInstanceOperation) Metadata

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

                                                                          func (*ExportInstanceOperation) Name

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

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

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

                                                                              If Poll fails, the error is returned and op is unmodified. If Poll succeeds 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 (*ExportInstanceOperation) Wait

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

                                                                                See documentation of Poll for error-handling information.

                                                                                type FailoverInstanceOperation

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

                                                                                  FailoverInstanceOperation manages a long-running operation from FailoverInstance.

                                                                                  func (*FailoverInstanceOperation) Done

                                                                                  func (op *FailoverInstanceOperation) Done() bool

                                                                                    Done reports whether the long-running operation has completed.

                                                                                    func (*FailoverInstanceOperation) Metadata

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

                                                                                      func (*FailoverInstanceOperation) Name

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

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

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

                                                                                          If Poll fails, the error is returned and op is unmodified. If Poll succeeds 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 (*FailoverInstanceOperation) Wait

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

                                                                                            See documentation of Poll for error-handling information.

                                                                                            type ImportInstanceOperation

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

                                                                                              ImportInstanceOperation manages a long-running operation from ImportInstance.

                                                                                              func (*ImportInstanceOperation) Done

                                                                                              func (op *ImportInstanceOperation) Done() bool

                                                                                                Done reports whether the long-running operation has completed.

                                                                                                func (*ImportInstanceOperation) Metadata

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

                                                                                                  func (*ImportInstanceOperation) Name

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

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

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

                                                                                                      If Poll fails, the error is returned and op is unmodified. If Poll succeeds 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 (*ImportInstanceOperation) Wait

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

                                                                                                        See documentation of Poll for error-handling information.

                                                                                                        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 []*redispb.Instance, nextPageToken string, err error)
                                                                                                        	// contains filtered or unexported fields
                                                                                                        }

                                                                                                          InstanceIterator manages a stream of *redispb.Instance.

                                                                                                          func (*InstanceIterator) Next

                                                                                                          func (it *InstanceIterator) Next() (*redispb.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 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

                                                                                                                    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

                                                                                                                        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

                                                                                                                          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 UpgradeInstanceOperation

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

                                                                                                                            UpgradeInstanceOperation manages a long-running operation from UpgradeInstance.

                                                                                                                            func (*UpgradeInstanceOperation) Done

                                                                                                                            func (op *UpgradeInstanceOperation) Done() bool

                                                                                                                              Done reports whether the long-running operation has completed.

                                                                                                                              func (*UpgradeInstanceOperation) Metadata

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

                                                                                                                                func (*UpgradeInstanceOperation) Name

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

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

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

                                                                                                                                    If Poll fails, the error is returned and op is unmodified. If Poll succeeds 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 (*UpgradeInstanceOperation) Wait

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

                                                                                                                                      See documentation of Poll for error-handling information.