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.
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
↳ update_time
↳ labels
↳ state
int
Output only. Current state of the instance.
↳ state_info
↳ 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
↳ 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
↳ 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
↳ mode
int
Optional. The mode config for the instance.
getName
Identifier. Unique name of the instance.
Format: projects/{project}/locations/{location}/instances/{instance}
string
setName
Identifier. Unique name of the instance.
Format: projects/{project}/locations/{location}/instances/{instance}
var
string
$this
getCreateTime
Output only. Creation timestamp of the instance.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp of the instance.
$this
getUpdateTime
Output only. Latest update timestamp of the instance.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Latest update timestamp of the instance.
$this
getLabels
Optional. Labels to represent user-provided metadata.
setLabels
Optional. Labels to represent user-provided metadata.
$this
getState
Output only. Current state of the instance.
int
setState
Output only. Current state of the instance.
var
int
$this
getStateInfo
Output only. Additional information about the state of the instance.
hasStateInfo
clearStateInfo
setStateInfo
Output only. Additional information about the state of the instance.
$this
getUid
Output only. System assigned, unique identifier for the instance.
string
setUid
Output only. System assigned, unique identifier for the instance.
var
string
$this
getReplicaCount
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
int
hasReplicaCount
clearReplicaCount
setReplicaCount
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.
var
int
$this
getAuthorizationMode
Optional. Immutable. Authorization mode of the instance.
int
setAuthorizationMode
Optional. Immutable. Authorization mode of the instance.
var
int
$this
getTransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
int
setTransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
var
int
$this
getShardCount
Optional. Number of shards for the instance.
int
setShardCount
Optional. Number of shards for the instance.
var
int
$this
getDiscoveryEndpoints
Output only. Endpoints clients can connect to the instance through.
Currently only one discovery endpoint is supported.
setDiscoveryEndpoints
Output only. Endpoints clients can connect to the instance through.
Currently only one discovery endpoint is supported.
$this
getNodeType
Optional. Immutable. Machine type for individual nodes of the instance.
int
setNodeType
Optional. Immutable. Machine type for individual nodes of the instance.
var
int
$this
getPersistenceConfig
Optional. Persistence configuration of the instance.
hasPersistenceConfig
clearPersistenceConfig
setPersistenceConfig
Optional. Persistence configuration of the instance.
$this
getEngineVersion
Optional. Immutable. Engine version of the instance.
string
setEngineVersion
Optional. Immutable. Engine version of the instance.
var
string
$this
getEngineConfigs
Optional. User-provided engine configurations for the instance.
setEngineConfigs
Optional. User-provided engine configurations for the instance.
$this
getNodeConfig
Output only. Configuration of individual nodes of the instance.
hasNodeConfig
clearNodeConfig
setNodeConfig
Output only. Configuration of individual nodes of the instance.
$this
getZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation.
hasZoneDistributionConfig
clearZoneDistributionConfig
setZoneDistributionConfig
Optional. Immutable. Zone distribution configuration of the instance for node allocation.
$this
getDeletionProtectionEnabled
Optional. If set to true deletion of the instance will fail.
bool
hasDeletionProtectionEnabled
clearDeletionProtectionEnabled
setDeletionProtectionEnabled
Optional. If set to true deletion of the instance will fail.
var
bool
$this
getPscAutoConnections
Required. Immutable. User inputs and resource details of the auto-created PSC connections.
setPscAutoConnections
Required. Immutable. User inputs and resource details of the auto-created PSC connections.
$this
getEndpoints
Optional. Endpoints for the instance.
setEndpoints
Optional. Endpoints for the instance.
$this
getMode
Optional. The mode config for the instance.
int
setMode
Optional. The mode config for the instance.
var
int
$this