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. |
↳ gcs_source |
Instance\GcsBackupSource
Optional. Immutable. Backups that stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects. |
↳ managed_backup_source |
Instance\ManagedBackupSource
Optional. Immutable. Backups that generated and managed by memorystore service. |
↳ 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. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead. |
↳ node_type |
int
Optional. Machine type for individual nodes of the instance. |
↳ persistence_config |
PersistenceConfig
Optional. Persistence configuration of the instance. |
↳ engine_version |
string
Optional. 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>
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead. |
↳ psc_attachment_details |
array<PscAttachmentDetail>
Output only. Service attachment details to configure PSC connections. |
↳ endpoints |
array<Instance\InstanceEndpoint>
Optional. Endpoints for the instance. |
↳ mode |
int
Optional. The mode config for the instance. |
↳ ondemand_maintenance |
bool
Optional. Input only. Ondemand maintenance for the instance. |
↳ maintenance_policy |
MaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule. |
↳ maintenance_schedule |
MaintenanceSchedule
Output only. Published maintenance schedule. |
↳ cross_instance_replication_config |
CrossInstanceReplicationConfig
Optional. The config for cross instance replication. |
↳ async_instance_endpoints_deletion_enabled |
bool
Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted. |
↳ backup_collection |
string
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection} |
↳ automated_backup_config |
AutomatedBackupConfig
Optional. The automated backup config for the instance. |
getGcsSource
Optional. Immutable. Backups that stored in Cloud Storage buckets.
The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects.
| Returns | |
|---|---|
| Type | Description |
Instance\GcsBackupSource|null |
|
hasGcsSource
setGcsSource
Optional. Immutable. Backups that stored in Cloud Storage buckets.
The Cloud Storage buckets need to be the same region as the instances. Read permission is required to import from the provided Cloud Storage Objects.
| Parameter | |
|---|---|
| Name | Description |
var |
Instance\GcsBackupSource
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getManagedBackupSource
Optional. Immutable. Backups that generated and managed by memorystore service.
| Returns | |
|---|---|
| Type | Description |
Instance\ManagedBackupSource|null |
|
hasManagedBackupSource
setManagedBackupSource
Optional. Immutable. Backups that generated and managed by memorystore service.
| Parameter | |
|---|---|
| Name | Description |
var |
Instance\ManagedBackupSource
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDiscoveryEndpoints
Output only. Deprecated: Use the endpoints.connections.psc_auto_connection or endpoints.connections.psc_connection values instead.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DiscoveryEndpoint>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodeType
Optional. Machine type for individual nodes of the instance.
| Returns | |
|---|---|
| Type | Description |
int |
|
setNodeType
Optional. 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. Engine version of the instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEngineVersion
Optional. 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
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPscAutoConnections
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PscAutoConnection>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPscAttachmentDetails
Output only. Service attachment details to configure PSC connections.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPscAttachmentDetails
Output only. Service attachment details to configure PSC connections.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PscAttachmentDetail>
|
| 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 |
|
getOndemandMaintenance
Optional. Input only. Ondemand maintenance for the instance.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasOndemandMaintenance
clearOndemandMaintenance
setOndemandMaintenance
Optional. Input only. Ondemand maintenance for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
| Returns | |
|---|---|
| Type | Description |
MaintenancePolicy|null |
|
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
| Parameter | |
|---|---|
| Name | Description |
var |
MaintenancePolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceSchedule
Output only. Published maintenance schedule.
| Returns | |
|---|---|
| Type | Description |
MaintenanceSchedule|null |
|
hasMaintenanceSchedule
clearMaintenanceSchedule
setMaintenanceSchedule
Output only. Published maintenance schedule.
| Parameter | |
|---|---|
| Name | Description |
var |
MaintenanceSchedule
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCrossInstanceReplicationConfig
Optional. The config for cross instance replication.
| Returns | |
|---|---|
| Type | Description |
CrossInstanceReplicationConfig|null |
|
hasCrossInstanceReplicationConfig
clearCrossInstanceReplicationConfig
setCrossInstanceReplicationConfig
Optional. The config for cross instance replication.
| Parameter | |
|---|---|
| Name | Description |
var |
CrossInstanceReplicationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAsyncInstanceEndpointsDeletionEnabled
Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasAsyncInstanceEndpointsDeletionEnabled
clearAsyncInstanceEndpointsDeletionEnabled
setAsyncInstanceEndpointsDeletionEnabled
Optional. If true, instance endpoints that are created and registered by customers can be deleted asynchronously. That is, such an instance endpoint can be de-registered before the forwarding rules in the instance endpoint are deleted.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupCollection
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasBackupCollection
clearBackupCollection
setBackupCollection
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutomatedBackupConfig
Optional. The automated backup config for the instance.
| Returns | |
|---|---|
| Type | Description |
AutomatedBackupConfig|null |
|
hasAutomatedBackupConfig
clearAutomatedBackupConfig
setAutomatedBackupConfig
Optional. The automated backup config for the instance.
| Parameter | |
|---|---|
| Name | Description |
var |
AutomatedBackupConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImportSources
| Returns | |
|---|---|
| Type | Description |
string |
|