Class CloudMemcacheClient (1.4.1)

CloudMemcacheClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.memcache_v1beta2.services.cloud_memcache.transports.base.CloudMemcacheTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Type	Description
CloudMemcacheTransport	The transport used by the client instance.

Methods

CloudMemcacheClient

CloudMemcacheClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.memcache_v1beta2.services.cloud_memcache.transports.base.CloudMemcacheTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the cloud memcache client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	`Union[str, CloudMemcacheTransport]` The transport to use. If set to None, a transport is chosen automatically.
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

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, google.api_core.gapic_v1.method._MethodDefault] = <_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.

from google.cloud import memcache_v1beta2

def sample_apply_parameters():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    request = memcache_v1beta2.ApplyParametersRequest(
        name="name_value",
    )

    # Make the request
    operation = client.apply_parameters(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.api_core.operation.Operation	An 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates software on the selected nodes of the Instance.

from google.cloud import memcache_v1beta2

def sample_apply_software_update():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    request = memcache_v1beta2.ApplySoftwareUpdateRequest(
        instance="instance_value",
    )

    # Make the request
    operation = client.apply_software_update(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.api_core.operation.Operation	An 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.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Instance in a given location.

from google.cloud import memcache_v1beta2

def sample_create_instance():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    resource = memcache_v1beta2.Instance()
    resource.name = "name_value"
    resource.node_count = 1070
    resource.node_config.cpu_count = 976
    resource.node_config.memory_size_mb = 1505

    request = memcache_v1beta2.CreateInstanceRequest(
        parent="parent_value",
        instance_id="instance_id_value",
        resource=resource,
    )

    # Make the request
    operation = client.create_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.api_core.operation.Operation	An 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Instance.

from google.cloud import memcache_v1beta2

def sample_delete_instance():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    request = memcache_v1beta2.DeleteInstanceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type

Description

google.api_core.operation.Operation

An 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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
CloudMemcacheClient	The 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.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
CloudMemcacheClient	The 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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
CloudMemcacheClient	The 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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Instance.

from google.cloud import memcache_v1beta2

def sample_get_instance():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    request = memcache_v1beta2.GetInstanceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_instance(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.cloud.memcache_v1beta2.types.Instance	A Memorystore for Memcached instance

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

instance_path

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

Returns a fully-qualified instance string.

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Instances in a given location.

from google.cloud import memcache_v1beta2

def sample_list_instances():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    request = memcache_v1beta2.ListInstancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_instances(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
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

Type	Description
google.cloud.memcache_v1beta2.services.cloud_memcache.pagers.ListInstancesPager	Response 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.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_instance_path

parse_instance_path(path: str)

Parses a instance path into its component segments.

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing Instance in a given project and location.

from google.cloud import memcache_v1beta2

def sample_update_instance():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    resource = memcache_v1beta2.Instance()
    resource.name = "name_value"
    resource.node_count = 1070
    resource.node_config.cpu_count = 976
    resource.node_config.memory_size_mb = 1505

    request = memcache_v1beta2.UpdateInstanceRequest(
        resource=resource,
    )

    # Make the request
    operation = client.update_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.api_core.operation.Operation	An 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, google.api_core.gapic_v1.method._MethodDefault] = <_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.

from google.cloud import memcache_v1beta2

def sample_update_parameters():
    # Create a client
    client = memcache_v1beta2.CloudMemcacheClient()

    # Initialize request argument(s)
    request = memcache_v1beta2.UpdateParametersRequest(
        name="name_value",
    )

    # Make the request
    operation = client.update_parameters(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Memcached instance