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.
Example usage
To get started with this package, create a client.
ctx := context . Background () c , err := redis . NewCloudRedisClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () c , err := redis . NewCloudRedisClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & redispb . ListInstancesRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#ListInstancesRequest. } it := c . ListInstances ( ctx , req ) for { resp , err := it . Next () if err == iterator . Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
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 https://pkg.go.dev/cloud.google.com/go .
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
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.
CloudRedisClient
type
CloudRedisClient
struct
{
// The call options for this service.
CallOptions
*
CloudRedisCallOptions
// 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
}
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.
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
func NewCloudRedisClient
func
NewCloudRedisClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
CloudRedisClient
,
error
)
NewCloudRedisClient creates a new cloud redis 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 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
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
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
func
(
c
*
CloudRedisClient
)
CreateInstance
(
ctx
context
.
Context
,
req
*
redispb
.
CreateInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateInstanceOperation
,
error
)
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
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
CreateInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#CreateInstanceRequest.
}
op
,
err
:=
c
.
CreateInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
func
(
c
*
CloudRedisClient
)
DeleteInstance
(
ctx
context
.
Context
,
req
*
redispb
.
DeleteInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteInstanceOperation
,
error
)
DeleteInstance deletes a specific Redis instance. Instance stops serving and data is deleted.
Example
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
DeleteInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#DeleteInstanceRequest.
}
op
,
err
:=
c
.
DeleteInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
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
func
(
c
*
CloudRedisClient
)
ExportInstance
(
ctx
context
.
Context
,
req
*
redispb
.
ExportInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
ExportInstanceOperation
,
error
)
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
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
ExportInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#ExportInstanceRequest.
}
op
,
err
:=
c
.
ExportInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
func
(
c
*
CloudRedisClient
)
FailoverInstance
(
ctx
context
.
Context
,
req
*
redispb
.
FailoverInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
FailoverInstanceOperation
,
error
)
FailoverInstance initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
Example
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
FailoverInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#FailoverInstanceRequest.
}
op
,
err
:=
c
.
FailoverInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
func
(
c
*
CloudRedisClient
)
GetInstance
(
ctx
context
.
Context
,
req
*
redispb
.
GetInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
GetInstance gets the details of a specific Redis instance.
Example
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
GetInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#GetInstanceRequest.
}
resp
,
err
:=
c
.
GetInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CloudRedisClient) ImportInstance
func
(
c
*
CloudRedisClient
)
ImportInstance
(
ctx
context
.
Context
,
req
*
redispb
.
ImportInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
ImportInstanceOperation
,
error
)
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
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
ImportInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#ImportInstanceRequest.
}
op
,
err
:=
c
.
ImportInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
func
(
c
*
CloudRedisClient
)
ListInstances
(
ctx
context
.
Context
,
req
*
redispb
.
ListInstancesRequest
,
opts
...
gax
.
CallOption
)
*
InstanceIterator
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
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
"google.golang.org/api/iterator"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
ListInstancesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#ListInstancesRequest.
}
it
:=
c
.
ListInstances
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CloudRedisClient) UpdateInstance
func
(
c
*
CloudRedisClient
)
UpdateInstance
(
ctx
context
.
Context
,
req
*
redispb
.
UpdateInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateInstanceOperation
,
error
)
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
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
UpdateInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#UpdateInstanceRequest.
}
op
,
err
:=
c
.
UpdateInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
func
(
c
*
CloudRedisClient
)
UpgradeInstance
(
ctx
context
.
Context
,
req
*
redispb
.
UpgradeInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
UpgradeInstanceOperation
,
error
)
UpgradeInstance upgrades Redis instance to the newer Redis version specified in the request.
Example
package
main
import
(
"context"
redis
"cloud.google.com/go/redis/apiv1"
redispb
"google.golang.org/genproto/googleapis/cloud/redis/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
redis
.
NewCloudRedisClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& redispb
.
UpgradeInstanceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/redis/v1#UpgradeInstanceRequest.
}
op
,
err
:=
c
.
UpgradeInstance
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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.
CreateInstanceOperation
type
CreateInstanceOperation
struct
{
// contains filtered or unexported fields
}
CreateInstanceOperation manages a long-running operation from CreateInstance.
func (*CreateInstanceOperation) Done
func
(
op
*
CreateInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateInstanceOperation) Metadata
func
(
op
*
CreateInstanceOperation
)
Metadata
()
(
*
redispb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateInstanceOperation) Name
func
(
op
*
CreateInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateInstanceOperation) Poll
func
(
op
*
CreateInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateInstanceOperation) Wait
func
(
op
*
CreateInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
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
type
DeleteInstanceOperation
struct
{
// contains filtered or unexported fields
}
DeleteInstanceOperation manages a long-running operation from DeleteInstance.
func (*DeleteInstanceOperation) Done
func
(
op
*
DeleteInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteInstanceOperation) Metadata
func
(
op
*
DeleteInstanceOperation
)
Metadata
()
(
*
redispb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteInstanceOperation) Name
func
(
op
*
DeleteInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteInstanceOperation) Poll
func
(
op
*
DeleteInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteInstanceOperation) Wait
func
(
op
*
DeleteInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
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
func
(
op
*
ExportInstanceOperation
)
Metadata
()
(
*
redispb
.
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 (*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
func
(
op
*
ExportInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ExportInstanceOperation) Wait
func
(
op
*
ExportInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
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.
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
func
(
op
*
FailoverInstanceOperation
)
Metadata
()
(
*
redispb
.
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 (*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
func
(
op
*
FailoverInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*FailoverInstanceOperation) Wait
func
(
op
*
FailoverInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
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.
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
func
(
op
*
ImportInstanceOperation
)
Metadata
()
(
*
redispb
.
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 (*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
func
(
op
*
ImportInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ImportInstanceOperation) Wait
func
(
op
*
ImportInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
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.
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.
UpdateInstanceOperation
type
UpdateInstanceOperation
struct
{
// contains filtered or unexported fields
}
UpdateInstanceOperation manages a long-running operation from UpdateInstance.
func (*UpdateInstanceOperation) Done
func
(
op
*
UpdateInstanceOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateInstanceOperation) Metadata
func
(
op
*
UpdateInstanceOperation
)
Metadata
()
(
*
redispb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateInstanceOperation) Name
func
(
op
*
UpdateInstanceOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateInstanceOperation) Poll
func
(
op
*
UpdateInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateInstanceOperation) Wait
func
(
op
*
UpdateInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
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.
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
func
(
op
*
UpgradeInstanceOperation
)
Metadata
()
(
*
redispb
.
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 (*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
func
(
op
*
UpgradeInstanceOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
Instance
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpgradeInstanceOperation) Wait
func
(
op
*
UpgradeInstanceOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
redispb
.
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.
