Skip to main content

instances

Overview

Nameinstances
TypeResource
Idgoogle.memcache.instances

Fields

NameDatatypeDescription
namestringRequired. 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 the regional level so location_id here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
statestringOutput only. The state of this Memcached instance.
authorizedNetworkstringThe full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
nodeCountintegerRequired. Number of nodes in the Memcached instance.
zonesarrayZones in which Memcached nodes should be provisioned. 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.
parametersobject
reservedIpRangeIdarrayOptional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
createTimestringOutput only. The time the instance was created.
memcacheVersionstringThe 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.
memcacheFullVersionstringOutput 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".
maintenanceScheduleobjectUpcoming maintenance schedule.
nodeConfigobjectConfiguration for a Memcached Node.
labelsobjectResource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
instanceMessagesarrayList of messages that describe the current state of the Memcached instance.
displayNamestringUser provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
memcacheNodesarrayOutput only. List of Memcached nodes. Refer to Node message for more details.
updateTimestringOutput only. The time the instance was updated.
maintenancePolicyobjectMaintenance policy per instance.
discoveryEndpointstringOutput only. Endpoint for the Discovery API.

Methods

NameAccessible byRequired ParamsDescription
getSELECTinstancesId, locationsId, projectsIdGets details of a single Instance.
listSELECTlocationsId, projectsIdLists Instances in a given location.
createINSERTlocationsId, projectsIdCreates a new Instance in a given location.
deleteDELETEinstancesId, locationsId, projectsIdDeletes a single Instance.
_listEXEClocationsId, projectsIdLists Instances in a given location.
apply_parametersEXECinstancesId, locationsId, projectsIdApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
patchEXECinstancesId, locationsId, projectsIdUpdates an existing Instance in a given project and location.
reschedule_maintenanceEXECinstancesId, locationsId, projectsIdReschedules upcoming maintenance event.