Class CloudMemcacheClient

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

Inheritance

builtins.object > CloudMemcacheClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
CloudMemcacheTransportThe transport used by the client instance.

Methods

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

.. warning:: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

apply_parameters

apply_parameters(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.ApplyParametersRequest, dict]] = None, *, name: Optional[str] = None, node_ids: Optional[Sequence[str]] = None, apply_all: Optional[bool] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.ApplyParametersRequest, dict]

The request object. Request for ApplyParameters.

name str

Required. Resource name of the Memcached instance for which parameter group updates should be applied. This corresponds to the name field on the request instance; if request is provided, this should not be set.

node_ids Sequence[str]

Nodes to which the instance-level parameter group is applied. This corresponds to the node_ids field on the request instance; if request is provided, this should not be set.

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. This corresponds to the apply_all field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Memcached instance

apply_software_update

apply_software_update(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.ApplySoftwareUpdateRequest, dict]] = None, *, instance: Optional[str] = None, node_ids: Optional[Sequence[str]] = None, apply_all: Optional[bool] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates software on the selected nodes of the Instance.

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.ApplySoftwareUpdateRequest, dict]

The request object. Request for ApplySoftwareUpdate.

instance str

Required. Resource name of the Memcached instance for which software update should be applied. This corresponds to the instance field on the request instance; if request is provided, this should not be set.

node_ids Sequence[str]

Nodes to which we should apply the update to. Note all the selected nodes are updated in parallel. This corresponds to the node_ids field on the request instance; if request is provided, this should not be set.

apply_all bool

Whether to apply the update to all nodes. If set to true, will explicitly restrict users from specifying any nodes, and apply software update to all nodes (where applicable) within the instance. This corresponds to the apply_all field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Memcached instance

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_instance

create_instance(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, resource: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.Instance] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Instance in a given location.

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.CreateInstanceRequest, dict]

The request object. Request for CreateInstance.

parent str

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 This corresponds to the parent field on the request instance; if request is provided, this should not be set.

instance_id str

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. This corresponds to the instance_id field on the request instance; if request is provided, this should not be set.

resource google.cloud.memcache_v1beta2.types.Instance

Required. A Memcached [Instance] resource This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Memcached instance

delete_instance

delete_instance(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Instance.

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.DeleteInstanceRequest, dict]

The request object. Request for DeleteInstance.

name str

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 This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
CloudMemcacheClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
CloudMemcacheClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
CloudMemcacheClientThe constructed client.

get_instance

get_instance(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Instance.

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.GetInstanceRequest, dict]

The request object. Request for GetInstance.

name str

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 This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.memcache_v1beta2.types.InstanceA Memorystore for Memcached instance

instance_path

instance_path(project: str, location: str, instance: str)

Returns a fully-qualified instance string.

Parameters
NameDescription
project str
location str
instance str

list_instances

list_instances(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Instances in a given location.

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.ListInstancesRequest, dict]

The request object. Request for ListInstances.

parent str

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 This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.memcache_v1beta2.services.cloud_memcache.pagers.ListInstancesPagerResponse for ListInstances. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_instance_path

parse_instance_path(path: str)

Parses a instance path into its component segments.

Parameter
NameDescription
path str

update_instance

update_instance(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.UpdateInstanceRequest, dict]] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, resource: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.Instance] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing Instance in a given project and location.

Parameters
NameDescription
request Union[google.cloud.memcache_v1beta2.types.UpdateInstanceRequest, dict]

The request object. Request for UpdateInstance.

update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Mask of fields to update. - displayName This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

resource google.cloud.memcache_v1beta2.types.Instance

Required. A Memcached [Instance] resource. Only fields specified in update_mask are updated. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Memcached instance

update_parameters

update_parameters(request: Optional[Union[google.cloud.memcache_v1beta2.types.cloud_memcache.UpdateParametersRequest, dict]] = None, *, name: Optional[str] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, parameters: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.MemcacheParameters] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
NameDescription
request Union[google.cloud.memcache_v1beta2.types.UpdateParametersRequest, dict]

The request object. Request for UpdateParameters.

name str

Required. Resource name of the Memcached instance for which the parameters should be updated. This corresponds to the name field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Mask of fields to update. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

parameters google.cloud.memcache_v1beta2.types.MemcacheParameters

The parameters to apply to the instance. This corresponds to the parameters field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Memcached instance