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.
↳ 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
↳ 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. Deprecated: The discovery_endpoints parameter is deprecated. As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.
↳ node_type
int
Optional. Machine type for individual nodes of the instance.
↳ persistence_config
↳ 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
↳ 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
↳ endpoints
↳ mode
int
Optional. The mode config for the instance.
↳ simulate_maintenance_event
bool
Optional. Input only. Simulate a maintenance event.
↳ ondemand_maintenance
bool
Optional. Input only. Ondemand maintenance for the instance.
↳ satisfies_pzs
bool
Optional. Output only. Reserved for future use.
↳ satisfies_pzi
bool
Optional. Output only. Reserved for future use.
↳ 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
↳ cross_instance_replication_config
↳ 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.
↳ kms_key
string
Optional. The KMS key used to encrypt the at-rest data of the cluster.
↳ encryption_info
↳ backup_collection
string
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
↳ automated_backup_config
↳ maintenance_version
string
Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
↳ effective_maintenance_version
string
Output only. This field represents the actual maintenance version of the instance.
↳ available_maintenance_versions
array
Output only. This field is used to determine the available maintenance versions for the self service update.
↳ allow_fewer_zones_deployment
bool
Optional. Immutable. Deprecated, do not use.
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.
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.
$this
getManagedBackupSource
Optional. Immutable. Backups that generated and managed by memorystore service.
hasManagedBackupSource
setManagedBackupSource
Optional. Immutable. Backups that generated and managed by memorystore service.
$this
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.
setState
Output only. Current state of the instance.
$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.
setAuthorizationMode
Optional. Immutable. Authorization mode of the instance.
$this
getTransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
setTransitEncryptionMode
Optional. Immutable. In-transit encryption mode of the instance.
$this
getShardCount
Optional. Number of shards for the instance.
int
setShardCount
Optional. Number of shards for the instance.
var
int
$this
getDiscoveryEndpoints
Output only. Deprecated: The discovery_endpoints parameter is deprecated.
As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.
setDiscoveryEndpoints
Output only. Deprecated: The discovery_endpoints parameter is deprecated.
As a result, it will not be populated if the connections are created using endpoints parameter. Instead of this parameter, for discovery, use endpoints.connections.pscConnection and endpoints.connections.pscAutoConnection with connectionType CONNECTION_TYPE_DISCOVERY.
$this
getNodeType
Optional. Machine type for individual nodes of the instance.
setNodeType
Optional. Machine type for individual nodes of the instance.
$this
getPersistenceConfig
Optional. Persistence configuration of the instance.
hasPersistenceConfig
clearPersistenceConfig
setPersistenceConfig
Optional. Persistence configuration of the instance.
$this
getEngineVersion
Optional. Engine version of the instance.
string
setEngineVersion
Optional. 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
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
setPscAutoConnections
Optional. Immutable. Deprecated: Use the endpoints.connections.psc_auto_connection value instead.
$this
getPscAttachmentDetails
Output only. Service attachment details to configure PSC connections.
setPscAttachmentDetails
Output only. Service attachment details to configure PSC connections.
$this
getEndpoints
Optional. Endpoints for the instance.
setEndpoints
Optional. Endpoints for the instance.
$this
getMode
Optional. The mode config for the instance.
setMode
Optional. The mode config for the instance.
$this
getSimulateMaintenanceEvent
Optional. Input only. Simulate a maintenance event.
bool
hasSimulateMaintenanceEvent
clearSimulateMaintenanceEvent
setSimulateMaintenanceEvent
Optional. Input only. Simulate a maintenance event.
var
bool
$this
getOndemandMaintenance
Optional. Input only. Ondemand maintenance for the instance.
bool
hasOndemandMaintenance
clearOndemandMaintenance
setOndemandMaintenance
Optional. Input only. Ondemand maintenance for the instance.
var
bool
$this
getSatisfiesPzs
Optional. Output only. Reserved for future use.
bool
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
Optional. Output only. Reserved for future use.
var
bool
$this
getSatisfiesPzi
Optional. Output only. Reserved for future use.
bool
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
Optional. Output only. Reserved for future use.
var
bool
$this
getMaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, the maintenance event will be performed based on Memorystore internal rollout schedule.
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.
$this
getMaintenanceSchedule
Output only. Published maintenance schedule.
hasMaintenanceSchedule
clearMaintenanceSchedule
setMaintenanceSchedule
Output only. Published maintenance schedule.
$this
getCrossInstanceReplicationConfig
Optional. The config for cross instance replication.
hasCrossInstanceReplicationConfig
clearCrossInstanceReplicationConfig
setCrossInstanceReplicationConfig
Optional. The config for cross instance replication.
$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.
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.
var
bool
$this
getKmsKey
Optional. The KMS key used to encrypt the at-rest data of the cluster.
string
hasKmsKey
clearKmsKey
setKmsKey
Optional. The KMS key used to encrypt the at-rest data of the cluster.
var
string
$this
getEncryptionInfo
Output only. Encryption information of the data at rest of the cluster.
hasEncryptionInfo
clearEncryptionInfo
setEncryptionInfo
Output only. Encryption information of the data at rest of the cluster.
$this
getBackupCollection
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
string
hasBackupCollection
clearBackupCollection
setBackupCollection
Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
var
string
$this
getAutomatedBackupConfig
Optional. The automated backup config for the instance.
hasAutomatedBackupConfig
clearAutomatedBackupConfig
setAutomatedBackupConfig
Optional. The automated backup config for the instance.
$this
getMaintenanceVersion
Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
string
hasMaintenanceVersion
clearMaintenanceVersion
setMaintenanceVersion
Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
var
string
$this
getEffectiveMaintenanceVersion
Output only. This field represents the actual maintenance version of the instance.
string
hasEffectiveMaintenanceVersion
clearEffectiveMaintenanceVersion
setEffectiveMaintenanceVersion
Output only. This field represents the actual maintenance version of the instance.
var
string
$this
getAvailableMaintenanceVersions
Output only. This field is used to determine the available maintenance versions for the self service update.
setAvailableMaintenanceVersions
Output only. This field is used to determine the available maintenance versions for the self service update.
var
string[]
$this
getAllowFewerZonesDeployment
Optional. Immutable. Deprecated, do not use.
bool
setAllowFewerZonesDeployment
Optional. Immutable. Deprecated, do not use.
var
bool
$this
getImportSources
string
