Reference documentation and code samples for the Google Cloud Redis V1 Client class Instance.
A Memorystore for Redis instance.
Generated from protobuf message google.cloud.redis.v1.Instance
Namespace
Google \ Cloud \ Redis \ 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: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id
and alternative_location_id
fields for more details.
↳ display_name
string
An arbitrary and optional user-provided name for the instance.
↳ labels
↳ location_id
string
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
↳ alternative_location_id
string
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
↳ redis_version
string
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2
for Redis 3.2 compatibility * REDIS_4_0
for Redis 4.0 compatibility (default) * REDIS_5_0
for Redis 5.0 compatibility * REDIS_6_X
for Redis 6.x compatibility
↳ reserved_ip_range
string
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
↳ secondary_ip_range
string
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
↳ host
string
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
↳ port
int
Output only. The port number of the exposed Redis endpoint.
↳ current_location_id
string
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
↳ create_time
↳ state
int
Output only. The current state of this instance.
↳ status_message
string
Output only. Additional information about the current status of this instance, if available.
↳ redis_configs
array| Google\Protobuf\Internal\MapField
Optional. Redis configuration parameters, according to http://redis.io/topics/config . Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
↳ tier
int
Required. The service tier of the instance.
↳ memory_size_gb
int
Required. Redis memory size in GiB.
↳ authorized_network
string
Optional. The full name of the Google Compute Engine network
to which the instance is connected. If left unspecified, the default
network will be used.
↳ persistence_iam_identity
string
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
↳ connect_mode
int
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
↳ auth_enabled
bool
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
↳ server_ca_certs
array< Google\Cloud\Redis\V1\TlsCertificate
>
Output only. List of server CA certificates for the instance.
↳ transit_encryption_mode
int
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
↳ maintenance_policy
Google\Cloud\Redis\V1\MaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
↳ maintenance_schedule
Google\Cloud\Redis\V1\MaintenanceSchedule
Output only. Date and time of upcoming maintenance events which have been scheduled.
↳ replica_count
int
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
↳ nodes
↳ read_endpoint
string
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
↳ read_endpoint_port
int
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
↳ read_replicas_mode
int
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
↳ customer_managed_key
string
Optional. The KMS key reference that the customer provides when trying to create the instance.
↳ persistence_config
↳ suspension_reasons
array
Optional. reasons that causes instance in "SUSPENDED" state.
↳ maintenance_version
string
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
↳ available_maintenance_versions
array
Optional. The available maintenance versions that an instance could update to.
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: Redis instances are managed and addressed at regional level so
location_id here refers to a GCP region; however, users may choose which
specific zone (or collection of zones for cross-zone instances) an instance
should be provisioned in. Refer to location_id
and alternative_location_id
fields 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: Redis instances are managed and addressed at regional level so
location_id here refers to a GCP region; however, users may choose which
specific zone (or collection of zones for cross-zone instances) an instance
should be provisioned in. Refer to location_id
and alternative_location_id
fields for more details.
var
string
$this
getDisplayName
An arbitrary and optional user-provided name for the instance.
string
setDisplayName
An arbitrary and optional user-provided name for the instance.
var
string
$this
getLabels
Resource labels to represent user provided metadata
setLabels
Resource labels to represent user provided metadata
$this
getLocationId
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance.
For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
string
setLocationId
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance.
For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
var
string
$this
getAlternativeLocationId
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
string
setAlternativeLocationId
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.
var
string
$this
getRedisVersion
Optional. The version of Redis software.
If not provided, latest supported version will be used. Currently, the supported values are:
-
REDIS_3_2
for Redis 3.2 compatibility -
REDIS_4_0
for Redis 4.0 compatibility (default) -
REDIS_5_0
for Redis 5.0 compatibility -
REDIS_6_X
for Redis 6.x compatibility
string
setRedisVersion
Optional. The version of Redis software.
If not provided, latest supported version will be used. Currently, the supported values are:
-
REDIS_3_2
for Redis 3.2 compatibility -
REDIS_4_0
for Redis 4.0 compatibility (default) -
REDIS_5_0
for Redis 5.0 compatibility -
REDIS_6_X
for Redis 6.x compatibility
var
string
$this
getReservedIpRange
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection.
If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
string
setReservedIpRange
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection.
If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
var
string
$this
getSecondaryIpRange
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
string
setSecondaryIpRange
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
var
string
$this
getHost
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
string
setHost
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
var
string
$this
getPort
Output only. The port number of the exposed Redis endpoint.
int
setPort
Output only. The port number of the exposed Redis endpoint.
var
int
$this
getCurrentLocationId
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
string
setCurrentLocationId
Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.
var
string
$this
getCreateTime
Output only. The time the instance was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the instance was created.
$this
getState
Output only. The current state of this instance.
int
setState
Output only. The current state of this instance.
var
int
$this
getStatusMessage
Output only. Additional information about the current status of this instance, if available.
string
setStatusMessage
Output only. Additional information about the current status of this instance, if available.
var
string
$this
getRedisConfigs
Optional. Redis configuration parameters, according to http://redis.io/topics/config . Currently, the only supported parameters are: Redis version 3.2 and newer:
- maxmemory-policy
- notify-keyspace-events Redis version 4.0 and newer:
- activedefrag
- lfu-decay-time
- lfu-log-factor
- maxmemory-gb Redis version 5.0 and newer:
- stream-node-max-bytes
- stream-node-max-entries
setRedisConfigs
Optional. Redis configuration parameters, according to http://redis.io/topics/config . Currently, the only supported parameters are: Redis version 3.2 and newer:
- maxmemory-policy
- notify-keyspace-events Redis version 4.0 and newer:
- activedefrag
- lfu-decay-time
- lfu-log-factor
- maxmemory-gb Redis version 5.0 and newer:
- stream-node-max-bytes
- stream-node-max-entries
$this
getTier
Required. The service tier of the instance.
int
setTier
Required. The service tier of the instance.
var
int
$this
getMemorySizeGb
Required. Redis memory size in GiB.
int
setMemorySizeGb
Required. Redis memory size in GiB.
var
int
$this
getAuthorizedNetwork
Optional. 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
Optional. 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
getPersistenceIamIdentity
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
string
setPersistenceIamIdentity
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:<service_account_email>". The value may change over time for a given instance so should be checked before each import/export operation.
var
string
$this
getConnectMode
Optional. The network connect mode of the Redis instance.
If not provided, the connect mode defaults to DIRECT_PEERING.
int
setConnectMode
Optional. The network connect mode of the Redis instance.
If not provided, the connect mode defaults to DIRECT_PEERING.
var
int
$this
getAuthEnabled
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
bool
setAuthEnabled
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
var
bool
$this
getServerCaCerts
Output only. List of server CA certificates for the instance.
setServerCaCerts
Output only. List of server CA certificates for the instance.
$this
getTransitEncryptionMode
Optional. The TLS mode of the Redis instance.
If not provided, TLS is disabled for the instance.
int
setTransitEncryptionMode
Optional. The TLS mode of the Redis instance.
If not provided, TLS is disabled for the instance.
var
int
$this
getMaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
$this
getMaintenanceSchedule
Output only. Date and time of upcoming maintenance events which have been scheduled.
hasMaintenanceSchedule
clearMaintenanceSchedule
setMaintenanceSchedule
Output only. Date and time of upcoming maintenance events which have been scheduled.
$this
getReplicaCount
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
int
setReplicaCount
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
var
int
$this
getNodes
Output only. Info per node.
setNodes
Output only. Info per node.
$this
getReadEndpoint
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
string
setReadEndpoint
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.
var
string
$this
getReadEndpointPort
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
int
setReadEndpointPort
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
var
int
$this
getReadReplicasMode
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
int
setReadReplicasMode
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
var
int
$this
getCustomerManagedKey
Optional. The KMS key reference that the customer provides when trying to create the instance.
string
setCustomerManagedKey
Optional. The KMS key reference that the customer provides when trying to create the instance.
var
string
$this
getPersistenceConfig
Optional. Persistence configuration parameters
hasPersistenceConfig
clearPersistenceConfig
setPersistenceConfig
Optional. Persistence configuration parameters
$this
getSuspensionReasons
Optional. reasons that causes instance in "SUSPENDED" state.
setSuspensionReasons
Optional. reasons that causes instance in "SUSPENDED" state.
var
int[]
$this
getMaintenanceVersion
Optional. The self service update maintenance version.
The version is date based such as "20210712_00_00".
string
setMaintenanceVersion
Optional. The self service update maintenance version.
The version is date based such as "20210712_00_00".
var
string
$this
getAvailableMaintenanceVersions
Optional. The available maintenance versions that an instance could update to.
setAvailableMaintenanceVersions
Optional. The available maintenance versions that an instance could update to.
var
string[]
$this