Cloud Memorystore for Memcached API v1 - Package cloud.google.com/go/memcache/apiv1 (v1.11.7)
Package memcache is an auto-generated package for theCloud Memorystore for Memcached API.
Google Cloud Memorystore for Memcached API is used for creating andmanaging Memcached instances in GCP.
General documentation
For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/memcache/apiv1@latestctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req:=&memcachepb.ApplyParametersRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#ApplyParametersRequest.}op,err:=c.ApplyParameters(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp
Use of Context
The ctx passed to NewCloudMemcacheClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
funcDefaultAuthScopes()[]stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
ApplyParametersOperation
typeApplyParametersOperationstruct{// contains filtered or unexported fields}ApplyParametersOperation manages a long-running operation from ApplyParameters.
func (*ApplyParametersOperation) Done
func(op*ApplyParametersOperation)Done()boolDone reports whether the long-running operation has completed.
func (*ApplyParametersOperation) Metadata
func(op*ApplyParametersOperation)Metadata()(*memcachepb.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 (*ApplyParametersOperation) Name
func(op*ApplyParametersOperation)Name()stringName returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.
func (*ApplyParametersOperation) Poll
func(op*ApplyParametersOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ApplyParametersOperation) Wait
func(op*ApplyParametersOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.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.
CloudMemcacheCallOptions
typeCloudMemcacheCallOptionsstruct{ListInstances[]gax.CallOptionGetInstance[]gax.CallOptionCreateInstance[]gax.CallOptionUpdateInstance[]gax.CallOptionUpdateParameters[]gax.CallOptionDeleteInstance[]gax.CallOptionApplyParameters[]gax.CallOptionRescheduleMaintenance[]gax.CallOptionGetLocation[]gax.CallOptionListLocations[]gax.CallOptionCancelOperation[]gax.CallOptionDeleteOperation[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}CloudMemcacheCallOptions contains the retry settings for each method of CloudMemcacheClient.
CloudMemcacheClient
typeCloudMemcacheClientstruct{// The call options for this service.CallOptions*CloudMemcacheCallOptions// 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}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.
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com service implements the Google Cloud Memorystorefor Memcached API and defines the following resource model for managingMemorystore 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-memcachedfunc NewCloudMemcacheClient
funcNewCloudMemcacheClient(ctxcontext.Context,opts...option.ClientOption)(*CloudMemcacheClient,error)NewCloudMemcacheClient creates a new cloud memcache client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com service implements the Google Cloud Memorystorefor Memcached API and defines the following resource model for managingMemorystore 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-memcachedExample
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func NewCloudMemcacheRESTClient
funcNewCloudMemcacheRESTClient(ctxcontext.Context,opts...option.ClientOption)(*CloudMemcacheClient,error)NewCloudMemcacheRESTClient creates a new cloud memcache rest client.
Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com service implements the Google Cloud Memorystorefor Memcached API and defines the following resource model for managingMemorystore 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-memcachedExample
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func (*CloudMemcacheClient) ApplyParameters
func(c*CloudMemcacheClient)ApplyParameters(ctxcontext.Context,req*memcachepb.ApplyParametersRequest,opts...gax.CallOption)(*ApplyParametersOperation,error)ApplyParameters ApplyParameters restarts the set of specified nodes in order to updatethem to the current set of parameters for the Memcached Instance.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.ApplyParametersRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#ApplyParametersRequest.}op,err:=c.ApplyParameters(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) ApplyParametersOperation
func(c*CloudMemcacheClient)ApplyParametersOperation(namestring)*ApplyParametersOperationApplyParametersOperation 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) CancelOperation
func(c*CloudMemcacheClient)CancelOperation(ctxcontext.Context,req*longrunningpb.CancelOperationRequest,opts...gax.CallOption)errorCancelOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memcache"cloud.google.com/go/memcache/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.CancelOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.}err=c.CancelOperation(ctx,req)iferr!=nil{// TODO: Handle error.}}func (*CloudMemcacheClient) Close
func(c*CloudMemcacheClient)Close()errorClose closes the connection to the API service. The user should invoke this whenthe client is no longer required.
func (*CloudMemcacheClient) Connection (deprecated)
func(c*CloudMemcacheClient)Connection()*grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.
func (*CloudMemcacheClient) CreateInstance
func(c*CloudMemcacheClient)CreateInstance(ctxcontext.Context,req*memcachepb.CreateInstanceRequest,opts...gax.CallOption)(*CreateInstanceOperation,error)CreateInstance creates a new Instance in a given location.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.CreateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#CreateInstanceRequest.}op,err:=c.CreateInstance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) CreateInstanceOperation
func(c*CloudMemcacheClient)CreateInstanceOperation(namestring)*CreateInstanceOperationCreateInstanceOperation returns a new CreateInstanceOperation from a given name.The name must be that of a previously created CreateInstanceOperation, possibly from a different process.
func (*CloudMemcacheClient) DeleteInstance
func(c*CloudMemcacheClient)DeleteInstance(ctxcontext.Context,req*memcachepb.DeleteInstanceRequest,opts...gax.CallOption)(*DeleteInstanceOperation,error)DeleteInstance deletes a single Instance.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.DeleteInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#DeleteInstanceRequest.}op,err:=c.DeleteInstance(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*CloudMemcacheClient) DeleteInstanceOperation
func(c*CloudMemcacheClient)DeleteInstanceOperation(namestring)*DeleteInstanceOperationDeleteInstanceOperation returns a new DeleteInstanceOperation from a given name.The name must be that of a previously created DeleteInstanceOperation, possibly from a different process.
func (*CloudMemcacheClient) DeleteOperation
func(c*CloudMemcacheClient)DeleteOperation(ctxcontext.Context,req*longrunningpb.DeleteOperationRequest,opts...gax.CallOption)errorDeleteOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memcache"cloud.google.com/go/memcache/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.DeleteOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.}err=c.DeleteOperation(ctx,req)iferr!=nil{// TODO: Handle error.}}func (*CloudMemcacheClient) GetInstance
func(c*CloudMemcacheClient)GetInstance(ctxcontext.Context,req*memcachepb.GetInstanceRequest,opts...gax.CallOption)(*memcachepb.Instance,error)GetInstance gets details of a single Instance.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.GetInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#GetInstanceRequest.}resp,err:=c.GetInstance(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) GetLocation
func(c*CloudMemcacheClient)GetLocation(ctxcontext.Context,req*locationpb.GetLocationRequest,opts...gax.CallOption)(*locationpb.Location,error)GetLocation gets information about a location.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.GetLocationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.}resp,err:=c.GetLocation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) GetOperation
func(c*CloudMemcacheClient)GetOperation(ctxcontext.Context,req*longrunningpb.GetOperationRequest,opts...gax.CallOption)(*longrunningpb.Operation,error)GetOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memcache"cloud.google.com/go/memcache/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.}resp,err:=c.GetOperation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) ListInstances
func(c*CloudMemcacheClient)ListInstances(ctxcontext.Context,req*memcachepb.ListInstancesRequest,opts...gax.CallOption)*InstanceIteratorListInstances lists Instances in a given location.
Examples
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#ListInstancesRequest.}it:=c.ListInstances(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*memcachepb.ListInstancesResponse)}}all
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#ListInstancesRequest.}forresp,err:=rangec.ListInstances(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*CloudMemcacheClient) ListLocations
func(c*CloudMemcacheClient)ListLocations(ctxcontext.Context,req*locationpb.ListLocationsRequest,opts...gax.CallOption)*LocationIteratorListLocations lists information about the supported locations for this service.
Examples
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1""google.golang.org/api/iterator"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}it:=c.ListLocations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*locationpb.ListLocationsResponse)}}all
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}forresp,err:=rangec.ListLocations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*CloudMemcacheClient) ListOperations
func(c*CloudMemcacheClient)ListOperations(ctxcontext.Context,req*longrunningpb.ListOperationsRequest,opts...gax.CallOption)*OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memcache"cloud.google.com/go/memcache/apiv1""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}it:=c.ListOperations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*longrunningpb.ListOperationsResponse)}}all
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"memcache"cloud.google.com/go/memcache/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}forresp,err:=rangec.ListOperations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*CloudMemcacheClient) RescheduleMaintenance
func(c*CloudMemcacheClient)RescheduleMaintenance(ctxcontext.Context,req*memcachepb.RescheduleMaintenanceRequest,opts...gax.CallOption)(*RescheduleMaintenanceOperation,error)RescheduleMaintenance reschedules upcoming maintenance event.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.RescheduleMaintenanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#RescheduleMaintenanceRequest.}op,err:=c.RescheduleMaintenance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) RescheduleMaintenanceOperation
func(c*CloudMemcacheClient)RescheduleMaintenanceOperation(namestring)*RescheduleMaintenanceOperationRescheduleMaintenanceOperation returns a new RescheduleMaintenanceOperation from a given name.The name must be that of a previously created RescheduleMaintenanceOperation, possibly from a different process.
func (*CloudMemcacheClient) UpdateInstance
func(c*CloudMemcacheClient)UpdateInstance(ctxcontext.Context,req*memcachepb.UpdateInstanceRequest,opts...gax.CallOption)(*UpdateInstanceOperation,error)UpdateInstance updates an existing Instance in a given project and location.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.UpdateInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#UpdateInstanceRequest.}op,err:=c.UpdateInstance(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) UpdateInstanceOperation
func(c*CloudMemcacheClient)UpdateInstanceOperation(namestring)*UpdateInstanceOperationUpdateInstanceOperation returns a new UpdateInstanceOperation from a given name.The name must be that of a previously created UpdateInstanceOperation, possibly from a different process.
func (*CloudMemcacheClient) UpdateParameters
func(c*CloudMemcacheClient)UpdateParameters(ctxcontext.Context,req*memcachepb.UpdateParametersRequest,opts...gax.CallOption)(*UpdateParametersOperation,error)UpdateParameters updates the defined Memcached parameters for an existing instance.This method only stages the parameters, it must be followed byApplyParameters to apply the parameters to nodes of the Memcachedinstance.
Example
packagemainimport("context"memcache"cloud.google.com/go/memcache/apiv1"memcachepb"cloud.google.com/go/memcache/apiv1/memcachepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in:// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=memcache.NewCloudMemcacheClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&memcachepb.UpdateParametersRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/memcache/apiv1/memcachepb#UpdateParametersRequest.}op,err:=c.UpdateParameters(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*CloudMemcacheClient) UpdateParametersOperation
func(c*CloudMemcacheClient)UpdateParametersOperation(namestring)*UpdateParametersOperationUpdateParametersOperation returns a new UpdateParametersOperation from a given name.The name must be that of a previously created UpdateParametersOperation, possibly from a different process.
CreateInstanceOperation
typeCreateInstanceOperationstruct{// contains filtered or unexported fields}CreateInstanceOperation manages a long-running operation from CreateInstance.
func (*CreateInstanceOperation) Done
func(op*CreateInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateInstanceOperation) Metadata
func(op*CreateInstanceOperation)Metadata()(*memcachepb.OperationMetadata,error)Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.
func (*CreateInstanceOperation) Name
func(op*CreateInstanceOperation)Name()stringName returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateInstanceOperation) Poll
func(op*CreateInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateInstanceOperation) Wait
func(op*CreateInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.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.
DeleteInstanceOperation
typeDeleteInstanceOperationstruct{// contains filtered or unexported fields}DeleteInstanceOperation manages a long-running operation from DeleteInstance.
func (*DeleteInstanceOperation) Done
func(op*DeleteInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteInstanceOperation) Metadata
func(op*DeleteInstanceOperation)Metadata()(*memcachepb.OperationMetadata,error)Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteInstanceOperation) Name
func(op*DeleteInstanceOperation)Name()stringName returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteInstanceOperation) Poll
func(op*DeleteInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteInstanceOperation) Wait
func(op*DeleteInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
InstanceIterator
typeInstanceIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*memcachepb.Instance,nextPageTokenstring,errerror)// contains filtered or unexported fields}InstanceIterator manages a stream of *memcachepb.Instance.
func (*InstanceIterator) All
func(it*InstanceIterator)All()iter.Seq2[*memcachepb.Instance,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*InstanceIterator) Next
func(it*InstanceIterator)Next()(*memcachepb.Instance,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*InstanceIterator) PageInfo
func(it*InstanceIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
LocationIterator
typeLocationIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*locationpb.Location,nextPageTokenstring,errerror)// contains filtered or unexported fields}LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func(it*LocationIterator)All()iter.Seq2[*locationpb.Location,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*LocationIterator) Next
func(it*LocationIterator)Next()(*locationpb.Location,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func(it*LocationIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
OperationIterator
typeOperationIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*longrunningpb.Operation,nextPageTokenstring,errerror)// contains filtered or unexported fields}OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All
func(it*OperationIterator)All()iter.Seq2[*longrunningpb.Operation,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*OperationIterator) Next
func(it*OperationIterator)Next()(*longrunningpb.Operation,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func(it*OperationIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
RescheduleMaintenanceOperation
typeRescheduleMaintenanceOperationstruct{// contains filtered or unexported fields}RescheduleMaintenanceOperation manages a long-running operation from RescheduleMaintenance.
func (*RescheduleMaintenanceOperation) Done
func(op*RescheduleMaintenanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*RescheduleMaintenanceOperation) Metadata
func(op*RescheduleMaintenanceOperation)Metadata()(*memcachepb.OperationMetadata,error)Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.
func (*RescheduleMaintenanceOperation) Name
func(op*RescheduleMaintenanceOperation)Name()stringName returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.
func (*RescheduleMaintenanceOperation) Poll
func(op*RescheduleMaintenanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*RescheduleMaintenanceOperation) Wait
func(op*RescheduleMaintenanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateInstanceOperation
typeUpdateInstanceOperationstruct{// contains filtered or unexported fields}UpdateInstanceOperation manages a long-running operation from UpdateInstance.
func (*UpdateInstanceOperation) Done
func(op*UpdateInstanceOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateInstanceOperation) Metadata
func(op*UpdateInstanceOperation)Metadata()(*memcachepb.OperationMetadata,error)Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateInstanceOperation) Name
func(op*UpdateInstanceOperation)Name()stringName returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateInstanceOperation) Poll
func(op*UpdateInstanceOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateInstanceOperation) Wait
func(op*UpdateInstanceOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.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.
UpdateParametersOperation
typeUpdateParametersOperationstruct{// contains filtered or unexported fields}UpdateParametersOperation manages a long-running operation from UpdateParameters.
func (*UpdateParametersOperation) Done
func(op*UpdateParametersOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateParametersOperation) Metadata
func(op*UpdateParametersOperation)Metadata()(*memcachepb.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 (*UpdateParametersOperation) Name
func(op*UpdateParametersOperation)Name()stringName returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateParametersOperation) Poll
func(op*UpdateParametersOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateParametersOperation) Wait
func(op*UpdateParametersOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*memcachepb.Instance,error)Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.