Reference documentation and code samples for the Memorystore for Memcached V1 Client class Instance.
A Memorystore for Memcached instance
Generated from protobuf message google.cloud.memcache.v1.Instance
Namespace
Google \ Cloud \ Memcache \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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 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.
↳ display_name
string
User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
↳ labels
array| Google\Protobuf\Internal\MapField
Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
↳ authorized_network
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
array
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.
↳ node_count
int
Required. Number of nodes in the Memcached instance.
↳ node_config
↳ memcache_version
int
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
↳ memcache_nodes
array< Instance\Node
>
Output only. List of Memcached nodes. Refer to Node message for more details.
↳ create_time
↳ update_time
↳ state
int
Output only. The state of this Memcached instance.
↳ memcache_full_version
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".
↳ instance_messages
array< Instance\InstanceMessage
>
List of messages that describe the current state of the Memcached instance.
↳ discovery_endpoint
string
Output only. Endpoint for the Discovery API.
↳ maintenance_policy
MaintenancePolicy
The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
↳ maintenance_schedule
getName
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 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.
string
setName
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 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.
var
string
$this
getDisplayName
User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
string
setDisplayName
User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
var
string
$this
getLabels
Resource labels to represent user-provided metadata.
Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
setLabels
Resource labels to represent user-provided metadata.
Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
$this
getAuthorizedNetwork
The full name of the Google Compute Engine network
to which the
instance is connected. If left unspecified, the default
network
will be used.
string
setAuthorizedNetwork
The full name of the Google Compute Engine network
to which the
instance is connected. If left unspecified, the default
network
will be used.
var
string
$this
getZones
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.
setZones
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.
var
string[]
$this
getNodeCount
Required. Number of nodes in the Memcached instance.
int
setNodeCount
Required. Number of nodes in the Memcached instance.
var
int
$this
getNodeConfig
Required. Configuration for Memcached nodes.
hasNodeConfig
clearNodeConfig
setNodeConfig
Required. Configuration for Memcached nodes.
$this
getMemcacheVersion
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.
int
setMemcacheVersion
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.
var
int
$this
getParameters
User defined parameters to apply to the memcached process on each node.
hasParameters
clearParameters
setParameters
User defined parameters to apply to the memcached process on each node.
$this
getMemcacheNodes
Output only. List of Memcached nodes.
Refer to Node message for more details.
setMemcacheNodes
Output only. List of Memcached nodes.
Refer to Node message for more details.
$this
getCreateTime
Output only. The time the instance was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the instance was created.
$this
getUpdateTime
Output only. The time the instance was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the instance was updated.
$this
getState
Output only. The state of this Memcached instance.
int
setState
Output only. The state of this Memcached instance.
var
int
$this
getMemcacheFullVersion
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".
string
setMemcacheFullVersion
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".
var
string
$this
getInstanceMessages
List of messages that describe the current state of the Memcached instance.
setInstanceMessages
List of messages that describe the current state of the Memcached instance.
$this
getDiscoveryEndpoint
Output only. Endpoint for the Discovery API.
string
setDiscoveryEndpoint
Output only. Endpoint for the Discovery API.
var
string
$this
getMaintenancePolicy
The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
$this
getMaintenanceSchedule
Output only. Published maintenance schedule.
hasMaintenanceSchedule
clearMaintenanceSchedule
setMaintenanceSchedule
Output only. Published maintenance schedule.
$this
