Class CloudMemcacheClient (2.21.0)

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

CloudMemcacheClient(CloudMemcacheClient const &)

Copy and move support

Parameter
Name	Description
	`CloudMemcacheClient const &`

CloudMemcacheClient(CloudMemcacheClient &&)

Copy and move support

Parameter
Name	Description
	`CloudMemcacheClient &&`

CloudMemcacheClient(std::shared_ptr< CloudMemcacheConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< CloudMemcacheConnection >`
`opts`	`Options`

Operators

operator=(CloudMemcacheClient const &)

Copy and move support

Parameter
Name	Description
	`CloudMemcacheClient const &`

Returns
Type	Description
`CloudMemcacheClient &`

operator=(CloudMemcacheClient &&)

Copy and move support

Parameter
Name	Description
	`CloudMemcacheClient &&`

Returns
Type	Description
`CloudMemcacheClient &`

Functions

ListInstances(std::string const &, Options)

Lists Instances in a given location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::memcache::v1::Instance >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.memcache.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInstances(google::cloud::memcache::v1::ListInstancesRequest, Options)

Lists Instances in a given location.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::ListInstancesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.ListInstancesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::memcache::v1::Instance >

GetInstance(std::string const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
`name`	`std::string const &` Required. Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::memcache::v1::Instance >`	the result of the RPC. The response message type (google.cloud.memcache.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetInstance(google::cloud::memcache::v1::GetInstanceRequest const &, Options)

Gets details of a single Instance.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::GetInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.GetInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::memcache::v1::Instance >`	the result of the RPC. The response message type (google.cloud.memcache.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateInstance(std::string const &, google::cloud::memcache::v1::Instance const &, std::string const &, Options)

Creates a new Instance in a given location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region
`instance`	`google::cloud::memcache::v1::Instance const &` Required. A Memcached Instance
`instance_id`	`std::string const &` Required. The logical name of the Memcached instance in the user project with the following restrictions: Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-40 characters. Must end with a number or a letter. Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.memcache.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInstance(google::cloud::memcache::v1::CreateInstanceRequest const &, Options)

Creates a new Instance in a given location.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::CreateInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.CreateInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

UpdateInstance(google::cloud::memcache::v1::Instance const &, google::protobuf::FieldMask const &, Options)

Updates an existing Instance in a given project and location.

Parameters
Name	Description
`instance`	`google::cloud::memcache::v1::Instance const &` Required. A Memcached Instance. Only fields specified in update_mask are updated.
`update_mask`	`google::protobuf::FieldMask const &` Required. Mask of fields to update. `displayName`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

UpdateInstance(google::cloud::memcache::v1::UpdateInstanceRequest const &, Options)

Updates an existing Instance in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::UpdateInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.UpdateInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

UpdateParameters(std::string const &, google::protobuf::FieldMask const &, google::cloud::memcache::v1::MemcacheParameters const &, Options)

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.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the Memcached instance for which the parameters should be updated.
`update_mask`	`google::protobuf::FieldMask const &` Required. Mask of fields to update.
`parameters`	`google::cloud::memcache::v1::MemcacheParameters const &` The parameters to apply to the instance.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

UpdateParameters(google::cloud::memcache::v1::UpdateParametersRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::UpdateParametersRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.UpdateParametersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

DeleteInstance(std::string const &, Options)

Deletes a single Instance.

Parameters
Name	Description
`name`	`std::string const &` Required. Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.memcache.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstance(google::cloud::memcache::v1::DeleteInstanceRequest const &, Options)

Deletes a single Instance.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::DeleteInstanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.DeleteInstanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.memcache.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ApplyParameters(std::string const &, std::vector< std::string > const &, bool, Options)

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

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the Memcached instance for which parameter group updates should be applied.
`node_ids`	`std::vector< std::string > const &` Nodes to which the instance-level parameter group is applied.
`apply_all`	`bool` Whether to apply instance-level parameter group to all nodes. If set to true, users are restricted from specifying individual nodes, and `ApplyParameters` updates all nodes within the instance.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

ApplyParameters(google::cloud::memcache::v1::ApplyParametersRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::ApplyParametersRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.ApplyParametersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

RescheduleMaintenance(std::string const &, google::cloud::memcache::v1::RescheduleMaintenanceRequest::RescheduleType, google::protobuf::Timestamp const &, Options)

Reschedules upcoming maintenance event.

Parameters
Name	Description
`instance`	`std::string const &` Required. Memcache instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.
`reschedule_type`	`google::cloud::memcache::v1::RescheduleMaintenanceRequest::RescheduleType` Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
`schedule_time`	`google::protobuf::Timestamp const &` Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example `2012-11-15T16:19:00.094Z`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >

RescheduleMaintenance(google::cloud::memcache::v1::RescheduleMaintenanceRequest const &, Options)

Reschedules upcoming maintenance event.

Parameters
Name	Description
`request`	`google::cloud::memcache::v1::RescheduleMaintenanceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.memcache.v1.RescheduleMaintenanceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::memcache::v1::Instance > >