Client for Google Cloud Memcache API

class google.cloud.memcache_v1beta2.ApplyParametersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [ApplyParameters][google.cloud.memcache.v1beta2.CloudMemcache.ApplyParameters].

name()

Required. Resource name of the Memcached instance for which parameter group updates should be applied.

Type

str

node_ids()

Nodes to which we should apply the instance- evel parameter group.

Type

Sequence[str]

apply_all()

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.

Type

bool

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.CloudMemcacheClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.memcache_v1beta2.services.cloud_memcache.transports.base.CloudMemcacheTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-memcache/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None)

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 refering to a GCP region; for example:

projects/my-memcached-project/locations/us-central1/instances/my-memcached

Instantiate the cloud memcache client.

Parameters
- 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 (ClientOptions) – Custom options for the client. (1) The api_endpoint property can be used to override the default endpoint provided by the client. (2) If transport argument is None, client_options can be used to create a mutual TLS transport. If client_cert_source is provided, mutual TLS transport will be created with the given api_endpoint or the default mTLS endpoint, and the client SSL credentials obtained from client_cert_source.
Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

apply_parameters(request: Optional[google.cloud.memcache_v1beta2.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:

ApplyParameters will update current set of Parameters to the set of specified nodes of the Memcached Instance.

Parameters
- request (ApplyParametersRequest) – The request object. Request for [ApplyParameters][google.cloud.memcache.v1beta2.CloudMemcache.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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns

An object representing a long-running operation.

The result type for the operation will be :class:~.cloud_memcache.Instance:
Return type

Operation

create_instance(request: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.CreateInstanceRequest] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, resource: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.Instance] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Creates a new Instance in a given project and location.

Parameters
- request (CreateInstanceRequest) – The request object. Request for [CreateInstance][google.cloud.memcache.v1beta2.CloudMemcache.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
  This corresponds to the instance_id field on the request instance; if request is provided, this should not be set.
- resource (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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns

An object representing a long-running operation.

The result type for the operation will be :class:~.cloud_memcache.Instance:
Return type

Operation

delete_instance(request: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.DeleteInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Deletes a single Instance.

Parameters
- request (DeleteInstanceRequest) – The request object. Request for [DeleteInstance][google.cloud.memcache.v1beta2.CloudMemcache.DeleteInstance].
- name (str) – 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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns

An object representing a long-running operation.

The result type for the operation will be :class:~.empty.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 {}.
Return type

Operation

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

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

Parameters
- 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

The constructed client.
Return type

{@api.name}

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

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

Parameters
- 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

The constructed client.
Return type

{@api.name}

get_instance(request: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.GetInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Gets details of a single Instance.

Parameters
- request (GetInstanceRequest) – The request object. Request for [GetInstance][google.cloud.memcache.v1beta2.CloudMemcache.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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns
Return type

Instance

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

Return a fully-qualified instance string.

list_instances(request: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.ListInstancesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Lists Instances in a given project and location.

Parameters
- request (ListInstancesRequest) – The request object. Request for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns

Response for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].

Iterating over this object will yield results and resolve additional pages automatically.
Return type

ListInstancesPager

static parse_instance_path(path: str)

Parse a instance path into its component segments.

update_instance(request: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.UpdateInstanceRequest] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, resource: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.Instance] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Updates an existing Instance in a given project and location.

Parameters
- request (UpdateInstanceRequest) – The request object. Request for [UpdateInstance][google.cloud.memcache.v1beta2.CloudMemcache.UpdateInstance].
- update_mask (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 (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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns

An object representing a long-running operation.

The result type for the operation will be :class:~.cloud_memcache.Instance:
Return type

Operation

update_parameters(request: Optional[google.cloud.memcache_v1beta2.types.cloud_memcache.UpdateParametersRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

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
- request (UpdateParametersRequest) – The request object. Request for [UpdateParameters][google.cloud.memcache.v1beta2.CloudMemcache.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 (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 (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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.
Returns

An object representing a long-running operation.

The result type for the operation will be :class:~.cloud_memcache.Instance:
Return type

Operation

class google.cloud.memcache_v1beta2.CreateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [CreateInstance][google.cloud.memcache.v1beta2.CloudMemcache.CreateInstance].

parent()

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

Type

str

instance_id()

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
Type

str

resource()

Required. A Memcached [Instance] resource

Type

Instance

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [DeleteInstance][google.cloud.memcache.v1beta2.CloudMemcache.DeleteInstance].

name()

Memcached instance resource name in the format: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region

Type

str

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [GetInstance][google.cloud.memcache.v1beta2.CloudMemcache.GetInstance].

name()

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

Type

str

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

name()

Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.

Type

str

display_name()

Optional. User provided name for the instance only used for display purposes. Cannot be more than 80 characters.

Type

str

labels()

Optional. Resource labels to represent user- rovided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling- resources

Type

Sequence[LabelsEntry]

authorized_network()

Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.

Type

str

zones()

Optional. Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.

Type

Sequence[str]

node_count()

Required. Number of nodes in the Memcached instance.

Type

int

node_config()

Required. Configuration for Memcached nodes.

Type

NodeConfig

memcache_version()

Optional. The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.

Type

MemcacheVersion

parameters()

Optional: User defined parameters to apply to the memcached process on each node.

Type

MemcacheParameters

memcache_nodes()

Output only. List of Memcached nodes. Refer to [Node] message for more details.

Type

Sequence[Node]

create_time()

Output only. The time the instance was created.

Type

Timestamp

update_time()

Output only. The time the instance was updated.

Type

Timestamp

state()

Output only. The state of this Memcached instance.

Type

State

memcache_full_version()

Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be “memcached-1.5.16”.

Type

str

instance_messages()

List of messages that describe current statuses of memcached instance.

Type

Sequence[InstanceMessage]

discovery_endpoint()

Output only. Endpoint for Discovery API

Type

str

class InstanceMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

code()

A code that correspond to one type of user- acing message.

Type

Code

message()

Message on memcached instance which will be exposed to users.

Type

str

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class Node(mapping=None, *, ignore_unknown_fields=False, **kwargs)

node_id()

Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.

Type

str

zone()

Output only. Location (GCP Zone) for the Memcached node.

Type

str

state()

Output only. Current state of the Memcached node.

Type

State

host()

Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.

Type

str

port()

Output only. The port number of the Memcached server on this node.

Type

int

parameters()

User defined parameters currently applied to the node.

Type

MemcacheParameters

class State(value)

Different states of a Memcached node. LINT.IfChange

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class NodeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for a Memcached Node.

cpu_count()

Required. Number of cpus per Memcached node.

Type

int

memory_size_mb()

Required. Memory size in MiB for each Memcached node.

Type

int

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class State(value)

Different states of a Memcached instance. LINT.IfChange

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].

parent()

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

Type

str

page_size()

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response’s [next_page_token][CloudMemcache.ListInstancesResponse.next_page_token] to determine if there are more instances left to be queried.

Type

int

page_token()

The next_page_token value returned from a previous List request, if any.

Type

str

filter()

List filter. For example, exclude all Memcached instances with name as my-instance by specifying “name != my-instance”.

Type

str

order_by()

Sort results. Supported values are “name”, “name desc” or “” (unsorted).

Type

str

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.ListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Response for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].

resources()

A list of Memcached instances in the project in the specified location, or across all locations.

If the location_id in the parent field of the request is “-”, all regions available to the project are queried, and the results aggregated.

Type

Sequence[Instance]

next_page_token()

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

unreachable()

Locations that could not be reached.

Type

Sequence[str]

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.LocationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].

available_zones()

Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in the zones field when creating a Memcached instance.

Type

Sequence[AvailableZonesEntry]

class AvailableZonesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.MemcacheParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)

id()

Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.

Type

str

params()

User defined set of parameters to use in the memcached process.

Type

Sequence[ParamsEntry]

class ParamsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.MemcacheVersion(value)

Memcached versions supported by our service.

class google.cloud.memcache_v1beta2.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the metadata of a long-running operation.

create_time()

Time when the operation was created.

Type

Timestamp

end_time()

Time when the operation finished running.

Type

Timestamp

target()

Server-defined resource path for the target of the operation.

Type

str

verb()

Name of the verb executed by the operation.

Type

str

status_detail()

Human-readable status of the operation, if any.

Type

str

cancel_requested()

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Type

bool

api_version()

API version used to start the operation.

Type

str

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.UpdateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [UpdateInstance][google.cloud.memcache.v1beta2.CloudMemcache.UpdateInstance].

update_mask()

Required. Mask of fields to update.

displayName
Type

FieldMask

resource()

Required. A Memcached [Instance] resource. Only fields specified in update_mask are updated.

Type

Instance

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.memcache_v1beta2.UpdateParametersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request for [UpdateParameters][google.cloud.memcache.v1beta2.CloudMemcache.UpdateParameters].

name()

Required. Resource name of the Memcached instance for which the parameters should be updated.

Type

str

update_mask()

Required. Mask of fields to update.

Type

FieldMask

parameters()

The parameters to apply to the instance.

Type

MemcacheParameters

_delattr_(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_eq_(other)

Return True if the messages are equal, False otherwise.

_ne_(other)

Return True if the messages are unequal, False otherwise.

_setattr_(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.