Reference documentation and code samples for the Google Cloud Memorystore V1 Client class Instance.
A Memorystore instance.
Generated from protobuf message google.cloud.memorystore.v1.Instance
Namespace
Google \ Cloud \ Memorystore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance} |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation timestamp of the instance. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Latest update timestamp of the instance. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels to represent user-provided metadata. |
↳ state |
int
Output only. Current state of the instance. |
↳ state_info |
Instance\StateInfo
Output only. Additional information about the state of the instance. |
↳ uid |
string
Output only. System assigned, unique identifier for the instance. |
↳ replica_count |
int
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. |
↳ authorization_mode |
int
Optional. Immutable. Authorization mode of the instance. |
↳ transit_encryption_mode |
int
Optional. Immutable. In-transit encryption mode of the instance. |
↳ shard_count |
int
Optional. Number of shards for the instance. |
↳ discovery_endpoints |
array<DiscoveryEndpoint>
Output only. Endpoints clients can connect to the instance through. Currently only one discovery endpoint is supported. |
↳ node_type |
int
Optional. Immutable. Machine type for individual nodes of the instance. |
↳ persistence_config |
PersistenceConfig
Optional. Persistence configuration of the instance. |
↳ engine_version |
string
Optional. Immutable. Engine version of the instance. |
↳ engine_configs |
array|Google\Protobuf\Internal\MapField
Optional. User-provided engine configurations for the instance. |
↳ node_config |
NodeConfig
Output only. Configuration of individual nodes of the instance. |
↳ zone_distribution_config |
ZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation. |
↳ deletion_protection_enabled |
bool
Optional. If set to true deletion of the instance will fail. |
↳ psc_auto_connections |
array<PscAutoConnection>
Required. Immutable. User inputs and resource details of the auto-created PSC connections. |
↳ endpoints |
array<Instance\InstanceEndpoint>
Optional. Endpoints for the instance. |
↳ mode |
int
Optional. The mode config for the instance. |
getName
Identifier. Unique name of the instance.
Format: projects/{project}/locations/{location}/instances/{instance}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Unique name of the instance.
Format: projects/{project}/locations/{location}/instances/{instance}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Creation timestamp of the instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Latest update timestamp of the instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Latest update timestamp of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels to represent user-provided metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels to represent user-provided metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Current state of the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. Current state of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateInfo
Output only. Additional information about the state of the instance.
| Returns | |
|---|---|
| Type | Description |
Instance\StateInfo|null |
|
hasStateInfo
clearStateInfo
setStateInfo
Output only. Additional information about the state of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
Instance\StateInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. System assigned, unique identifier for the instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. System assigned, unique identifier for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReplicaCount
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasReplicaCount
clearReplicaCount
setReplicaCount
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthorizationMode
Optional. Immutable. Authorization mode of the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setAuthorizationMode
Optional. Immutable. Authorization mode of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShardCount
Optional. Number of shards for the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setShardCount
Optional. Number of shards for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDiscoveryEndpoints
Output only. Endpoints clients can connect to the instance through.
Currently only one discovery endpoint is supported.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDiscoveryEndpoints
Output only. Endpoints clients can connect to the instance through.
Currently only one discovery endpoint is supported.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DiscoveryEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodeType
Optional. Immutable. Machine type for individual nodes of the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setNodeType
Optional. Immutable. Machine type for individual nodes of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPersistenceConfig
Optional. Persistence configuration of the instance.
| Returns | |
|---|---|
| Type | Description |
PersistenceConfig|null |
|
hasPersistenceConfig
clearPersistenceConfig
setPersistenceConfig
Optional. Persistence configuration of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
PersistenceConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineVersion
Optional. Immutable. Engine version of the instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEngineVersion
Optional. Immutable. Engine version of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineConfigs
Optional. User-provided engine configurations for the instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setEngineConfigs
Optional. User-provided engine configurations for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodeConfig
Output only. Configuration of individual nodes of the instance.
| Returns | |
|---|---|
| Type | Description |
NodeConfig|null |
|
hasNodeConfig
clearNodeConfig
setNodeConfig
Output only. Configuration of individual nodes of the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
NodeConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation.
| Returns | |
|---|---|
| Type | Description |
ZoneDistributionConfig|null |
|
hasZoneDistributionConfig
clearZoneDistributionConfig
setZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation.
| Parameter | |
|---|---|
| Name | Description |
var |
ZoneDistributionConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeletionProtectionEnabled
Optional. If set to true deletion of the instance will fail.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasDeletionProtectionEnabled
clearDeletionProtectionEnabled
setDeletionProtectionEnabled
Optional. If set to true deletion of the instance will fail.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPscAutoConnections
Required. Immutable. User inputs and resource details of the auto-created PSC connections.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPscAutoConnections
Required. Immutable. User inputs and resource details of the auto-created PSC connections.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PscAutoConnection>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpoints
Optional. Endpoints for the instance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEndpoints
Optional. Endpoints for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Instance\InstanceEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMode
Optional. The mode config for the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMode
Optional. The mode config for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|