Class CloudMemcacheClient (1.0.0)

CloudMemcacheClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.memcache_v1.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

Properties

transport

Return 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_v1.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>)

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

apply_parameters

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

ApplyParameters will restart 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.types.ApplyParametersRequest` 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 we should apply the instance-level parameter group. 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, will explicitly restrict users from specifying any nodes, and apply parameter group updates to 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

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_instance

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

Creates a new Instance in a given location.

Parameters
Name	Description
`request`	`google.cloud.memcache_v1.types.CreateInstanceRequest` 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`	`google.cloud.memcache_v1.types.Instance` Required. A Memcached Instance This corresponds to the `instance` 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, will raise an invalid argument error. This corresponds to the `instance_id` 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

delete_instance

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

Deletes a single Instance.

Parameters
Name	Description
`request`	`google.cloud.memcache_v1.types.DeleteInstanceRequest` 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[google.cloud.memcache_v1.types.cloud_memcache.GetInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Instance.

Parameters
Name	Description
`request`	`google.cloud.memcache_v1.types.GetInstanceRequest` 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.

instance_path

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

Return a fully-qualified instance string.

list_instances

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

Lists Instances in a given location.

Parameters
Name	Description
`request`	`google.cloud.memcache_v1.types.ListInstancesRequest` 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_v1.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)

Parse a instance path into its component segments.

update_instance

update_instance(request: Optional[google.cloud.memcache_v1.types.cloud_memcache.UpdateInstanceRequest] = None, *, instance: Optional[google.cloud.memcache_v1.types.cloud_memcache.Instance] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`google.cloud.memcache_v1.types.UpdateInstanceRequest` The request object. Request for UpdateInstance.
`instance`	`google.cloud.memcache_v1.types.Instance` Required. A Memcached Instance. Only fields specified in update_mask are updated. This corresponds to the `instance` 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. - `displayName` This corresponds to the `update_mask` 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

update_parameters

update_parameters(request: Optional[google.cloud.memcache_v1.types.cloud_memcache.UpdateParametersRequest] = None, *, name: Optional[str] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, parameters: Optional[google.cloud.memcache_v1.types.cloud_memcache.MemcacheParameters] = None, retry: google.api_core.retry.Retry = <_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
Name	Description
`request`	`google.cloud.memcache_v1.types.UpdateParametersRequest` 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_v1.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