REST Resource: projects.locations.instances

Resource: Instance

A Memorystore for Memcached instance

JSON representation 
{
  "name": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "authorizedNetwork": string,
  "zones": [
    string
  ],
  "nodeCount": integer,
  "nodeConfig": {
    object (NodeConfig)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheNodes": [
    {
      object (Node)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "memcacheFullVersion": string,
  "instanceMessages": [
    {
      object (InstanceMessage)
    }
  ],
  "discoveryEndpoint": string,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "reservedIpRangeId": [
    string
  ]
}
Fields
name

string

Required. Unique name of the resource in this scope including project and location using the form: projects/{projectId}/locations/{locationId}/instances/{instanceId}

Note: Memcached instances are managed and addressed at the regional level so locationId 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.
displayName

string

User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
authorizedNetwork

string

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

string

Zones 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.
nodeCount

integer

Required. Number of nodes in the Memcached instance.
nodeConfig

object (NodeConfig)

Required. Configuration for Memcached nodes.
memcacheVersion

enum (MemcacheVersion)

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

object (MemcacheParameters)

User defined parameters to apply to the memcached process on each node.
memcacheNodes[]

object (Node)

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

string (Timestamp format)

Output only. The time the instance was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time the instance was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The state of this Memcached instance.
memcacheFullVersion

string

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".
instanceMessages[]

object (InstanceMessage)

List of messages that describe the current state of the Memcached instance.
discoveryEndpoint

string

Output only. Endpoint for the Discovery API.
maintenancePolicy

object (MaintenancePolicy)

The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
maintenanceSchedule

object (MaintenanceSchedule)

Output only. Published maintenance schedule.
reservedIpRangeId[]

string

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

NodeConfig

Configuration for a Memcached Node.

JSON representation 
{
  "cpuCount": integer,
  "memorySizeMb": integer
}
Fields
cpuCount

integer

Required. Number of cpus per Memcached node.
memorySizeMb

integer

Required. Memory size in MiB for each Memcached node.

MemcacheVersion

Memcached versions supported by our service.

Enums
MEMCACHE_VERSION_UNSPECIFIED Memcache version is not specified by customer
MEMCACHE_1_5 Memcached 1.5 version.
MEMCACHE_1_6_15 Memcached 1.6.15 version.

MemcacheParameters

JSON representation 
{
  "id": string,
  "params": {
    string: string,
    ...
  }
}
Fields
id

string

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. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes.
params

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Node

JSON representation 
{
  "nodeId": string,
  "zone": string,
  "state": enum (State),
  "host": string,
  "port": integer,
  "parameters": {
    object (MemcacheParameters)
  },
  "memcacheVersion": enum (MemcacheVersion),
  "memcacheFullVersion": string
}
Fields
nodeId

string

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

string

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

enum (State)

Output only. Current state of the Memcached node.
host

string

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

integer

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

object (MemcacheParameters)

User defined parameters currently applied to the node.
memcacheVersion

enum (MemcacheVersion)

Output only. Major version of memcached server running on this node, e.g. MEMCACHE_1_5
memcacheFullVersion

string

Output only. The full version of memcached server running on this node. e.g. - memcached-1.5.16

State

Different states of a Memcached node.

Enums
STATE_UNSPECIFIED Node state is not set.
CREATING Node is being created.
READY Node has been created and ready to be used.
DELETING Node is being deleted.
UPDATING Node is being updated.

State

Different states of a Memcached instance.

Enums
STATE_UNSPECIFIED State not set.
CREATING Memcached instance is being created.
READY Memcached instance has been created and ready to be used.
UPDATING Memcached instance is updating configuration such as maintenance policy and schedule.
DELETING Memcached instance is being deleted.
PERFORMING_MAINTENANCE Memcached instance is going through maintenance, e.g. data plane rollout.
MEMCACHE_VERSION_UPGRADING Memcached instance is undergoing memcached engine version upgrade.

InstanceMessage

JSON representation 
{
  "code": enum (Code),
  "message": string
}
Fields
code

enum (Code)

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

string

Message on memcached instance which will be exposed to users.

Code

Enums
CODE_UNSPECIFIED Message Code not set.
ZONE_DISTRIBUTION_UNBALANCED Memcached nodes are distributed unevenly.

MaintenancePolicy

Maintenance policy per instance.

JSON representation 
{
  "createTime": string,
  "updateTime": string,
  "description": string,
  "weeklyMaintenanceWindow": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ]
}
Fields
createTime

string (Timestamp format)

Output only. The time when the policy was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the policy was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
description

string

Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
weeklyMaintenanceWindow[]

object (WeeklyMaintenanceWindow)

Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one.

WeeklyMaintenanceWindow

Time window specified for weekly operations.

JSON representation 
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  },
  "duration": string
}
Fields
day

enum (DayOfWeek)

Required. Allows to define schedule that runs specified day of the week.
startTime

object (TimeOfDay)

Required. Start time of the window in UTC.
duration

string (Duration format)

Required. Duration of the time window.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

MaintenanceSchedule

Upcoming maintenance schedule.

JSON representation 
{
  "startTime": string,
  "endTime": string,
  "scheduleDeadlineTime": string
}
Fields
startTime

string (Timestamp format)

Output only. The start time of any upcoming scheduled maintenance for this instance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. The end time of any upcoming scheduled maintenance for this instance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
scheduleDeadlineTime

string (Timestamp format)

Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

applyParameters

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

create

 Creates a new Instance in a given location.

delete

 Deletes a single Instance.

get

 Gets details of a single Instance.

list

 Lists Instances in a given location.

patch

 Updates an existing Instance in a given project and location.

rescheduleMaintenance

 Reschedules upcoming maintenance event.

updateParameters

 Updates the defined Memcached parameters for an existing instance.

upgrade

 Upgrades the Memcache instance to a newer memcached engine version specified in the request.