Documentation

Overview

Package memcache is an auto-generated package for the Cloud Memorystore for Memcached API.

Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.

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 ApplyParametersOperation

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

      ApplyParametersOperation manages a long-running operation from ApplyParameters.

      func (*ApplyParametersOperation) Done

      func (op *ApplyParametersOperation) Done() bool

        Done reports whether the long-running operation has completed.

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

          func (op *ApplyParametersOperation) 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 (*ApplyParametersOperation) 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 (*ApplyParametersOperation) 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 ApplySoftwareUpdateOperation

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

                  ApplySoftwareUpdateOperation manages a long-running operation from ApplySoftwareUpdate.

                  func (*ApplySoftwareUpdateOperation) Done

                    Done reports whether the long-running operation has completed.

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

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

                        func (*ApplySoftwareUpdateOperation) 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 (*ApplySoftwareUpdateOperation) 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 CloudMemcacheCallOptions

                            type CloudMemcacheCallOptions struct {
                            	ListInstances       []gax.CallOption
                            	GetInstance         []gax.CallOption
                            	CreateInstance      []gax.CallOption
                            	UpdateInstance      []gax.CallOption
                            	UpdateParameters    []gax.CallOption
                            	DeleteInstance      []gax.CallOption
                            	ApplyParameters     []gax.CallOption
                            	ApplySoftwareUpdate []gax.CallOption
                            }

                              CloudMemcacheCallOptions contains the retry settings for each method of CloudMemcacheClient.

                              type CloudMemcacheClient

                              type CloudMemcacheClient 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 *CloudMemcacheCallOptions
                              	// contains filtered or unexported fields
                              }

                                CloudMemcacheClient is a client for interacting with Cloud Memorystore for Memcached API.

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

                                func NewCloudMemcacheClient

                                func NewCloudMemcacheClient(ctx context.Context, opts ...option.ClientOption) (*CloudMemcacheClient, error)

                                  NewCloudMemcacheClient creates a new cloud memcache client.

                                  Configures and manages Cloud Memorystore for Memcached instances.

                                  The memcache.googleapis.com service implements the Google Cloud Memorystore for Memcached API and defines the following resource model for managing Memorystore Memcached (also called Memcached below) 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 Memcached instances, named:
                                  /instances/*
                                  
                                  As such, Memcached instances are resources of the form:
                                  /projects/{project_id}/locations/{location_id}/instances/{instance_id}
                                  

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

                                  projects/my-memcached-project/locations/us-central1/instances/my-memcached
                                  
                                  Example
                                  Output:
                                  
                                  

                                  func (*CloudMemcacheClient) ApplyParameters

                                    ApplyParameters ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

                                    Example
                                    Output:
                                    
                                    

                                    func (*CloudMemcacheClient) ApplyParametersOperation

                                    func (c *CloudMemcacheClient) ApplyParametersOperation(name string) *ApplyParametersOperation

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

                                      func (*CloudMemcacheClient) ApplySoftwareUpdate

                                        ApplySoftwareUpdate updates software on the selected nodes of the Instance.

                                        Example
                                        Output:
                                        
                                        

                                        func (*CloudMemcacheClient) ApplySoftwareUpdateOperation

                                        func (c *CloudMemcacheClient) ApplySoftwareUpdateOperation(name string) *ApplySoftwareUpdateOperation

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

                                          func (*CloudMemcacheClient) Close

                                          func (c *CloudMemcacheClient) Close() error

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

                                            func (*CloudMemcacheClient) Connection

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

                                              Connection returns a connection to the API service.

                                              Deprecated.

                                              func (*CloudMemcacheClient) CreateInstance

                                                CreateInstance creates a new Instance in a given location.

                                                Example
                                                Output:
                                                
                                                

                                                func (*CloudMemcacheClient) CreateInstanceOperation

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

                                                    DeleteInstance deletes a single Instance.

                                                    Example
                                                    Output:
                                                    
                                                    

                                                    func (*CloudMemcacheClient) DeleteInstanceOperation

                                                    func (c *CloudMemcacheClient) 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 (*CloudMemcacheClient) GetInstance

                                                        GetInstance gets details of a single Instance.

                                                        Example
                                                        Output:
                                                        
                                                        

                                                        func (*CloudMemcacheClient) ListInstances

                                                          ListInstances lists Instances in a given location.

                                                          Example
                                                          Output:
                                                          
                                                          

                                                          func (*CloudMemcacheClient) UpdateInstance

                                                            UpdateInstance updates an existing Instance in a given project and location.

                                                            Example
                                                            Output:
                                                            
                                                            

                                                            func (*CloudMemcacheClient) UpdateInstanceOperation

                                                            func (c *CloudMemcacheClient) 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 (*CloudMemcacheClient) UpdateParameters

                                                                UpdateParameters updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

                                                                Example
                                                                Output:
                                                                
                                                                

                                                                func (*CloudMemcacheClient) UpdateParametersOperation

                                                                func (c *CloudMemcacheClient) UpdateParametersOperation(name string) *UpdateParametersOperation

                                                                  UpdateParametersOperation returns a new UpdateParametersOperation from a given name. The name must be that of a previously created UpdateParametersOperation, 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 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 []*memcachepb.Instance, nextPageToken string, err error)
                                                                                          	// contains filtered or unexported fields
                                                                                          }

                                                                                            InstanceIterator manages a stream of *memcachepb.Instance.

                                                                                            func (*InstanceIterator) Next

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

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

                                                                                                              UpdateParametersOperation manages a long-running operation from UpdateParameters.

                                                                                                              func (*UpdateParametersOperation) Done

                                                                                                              func (op *UpdateParametersOperation) Done() bool

                                                                                                                Done reports whether the long-running operation has completed.

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

                                                                                                                  func (op *UpdateParametersOperation) 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 (*UpdateParametersOperation) 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 (*UpdateParametersOperation) 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.