Google Cloud Redis V1 Client - Class Instance (2.1.2)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 array|Google\Protobuf\Internal\MapField

Resource labels to represent user provided metadata
↳ 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 Google\Protobuf\Timestamp

Output only. The time the instance was created.
↳ 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<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 MaintenancePolicy

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
↳ maintenance_schedule 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 array<NodeInfo>

Output only. Info per node.
↳ 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 PersistenceConfig

Optional. Persistence configuration parameters
↳ 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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

An arbitrary and optional user-provided name for the instance.

Returns
Type Description
string

setDisplayName

An arbitrary and optional user-provided name for the instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Resource labels to represent user provided metadata

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Resource labels to represent user provided metadata

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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
Returns
Type Description
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
Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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".

Returns
Type Description
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".

Parameter
Name Description
var string
Returns
Type Description
$this

getHost

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

Returns
Type Description
string

setHost

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

Parameter
Name Description
var string
Returns
Type Description
$this

getPort

Output only. The port number of the exposed Redis endpoint.

Returns
Type Description
int

setPort

Output only. The port number of the exposed Redis endpoint.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time the instance was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the instance was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. The current state of this instance.

Returns
Type Description
int

setState

Output only. The current state of this instance.

Parameter
Name Description
var int
Returns
Type Description
$this

getStatusMessage

Output only. Additional information about the current status of this instance, if available.

Returns
Type Description
string

setStatusMessage

Output only. Additional information about the current status of this instance, if available.

Parameter
Name Description
var string
Returns
Type Description
$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
Returns
Type Description
Google\Protobuf\Internal\MapField

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
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getTier

Required. The service tier of the instance.

Returns
Type Description
int

setTier

Required. The service tier of the instance.

Parameter
Name Description
var int
Returns
Type Description
$this

getMemorySizeGb

Required. Redis memory size in GiB.

Returns
Type Description
int

setMemorySizeGb

Required. Redis memory size in GiB.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectMode

Optional. The network connect mode of the Redis instance.

If not provided, the connect mode defaults to DIRECT_PEERING.

Returns
Type Description
int

setConnectMode

Optional. The network connect mode of the Redis instance.

If not provided, the connect mode defaults to DIRECT_PEERING.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getServerCaCerts

Output only. List of server CA certificates for the instance.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setServerCaCerts

Output only. List of server CA certificates for the instance.

Parameter
Name Description
var array<TlsCertificate>
Returns
Type Description
$this

getTransitEncryptionMode

Optional. The TLS mode of the Redis instance.

If not provided, TLS is disabled for the instance.

Returns
Type Description
int

setTransitEncryptionMode

Optional. The TLS mode of the Redis instance.

If not provided, TLS is disabled for the instance.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaintenancePolicy

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

Returns
Type Description
MaintenancePolicy|null

hasMaintenancePolicy

clearMaintenancePolicy

setMaintenancePolicy

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

Parameter
Name Description
var MaintenancePolicy
Returns
Type Description
$this

getMaintenanceSchedule

Output only. Date and time of upcoming maintenance events which have been scheduled.

Returns
Type Description
MaintenanceSchedule|null

hasMaintenanceSchedule

clearMaintenanceSchedule

setMaintenanceSchedule

Output only. Date and time of upcoming maintenance events which have been scheduled.

Parameter
Name Description
var MaintenanceSchedule
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$this

getNodes

Output only. Info per node.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setNodes

Output only. Info per node.

Parameter
Name Description
var array<NodeInfo>
Returns
Type Description
$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'.

Returns
Type Description
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'.

Parameter
Name Description
var string
Returns
Type Description
$this

getReadEndpointPort

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

Returns
Type Description
int

setReadEndpointPort

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

Parameter
Name Description
var int
Returns
Type Description
$this

getReadReplicasMode

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

Returns
Type Description
int

setReadReplicasMode

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

Parameter
Name Description
var int
Returns
Type Description
$this

getCustomerManagedKey

Optional. The KMS key reference that the customer provides when trying to create the instance.

Returns
Type Description
string

setCustomerManagedKey

Optional. The KMS key reference that the customer provides when trying to create the instance.

Parameter
Name Description
var string
Returns
Type Description
$this

getPersistenceConfig

Optional. Persistence configuration parameters

Returns
Type Description
PersistenceConfig|null

hasPersistenceConfig

clearPersistenceConfig

setPersistenceConfig

Optional. Persistence configuration parameters

Parameter
Name Description
var PersistenceConfig
Returns
Type Description
$this

getSuspensionReasons

Optional. reasons that causes instance in "SUSPENDED" state.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSuspensionReasons

Optional. reasons that causes instance in "SUSPENDED" state.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getMaintenanceVersion

Optional. The self service update maintenance version.

The version is date based such as "20210712_00_00".

Returns
Type Description
string

setMaintenanceVersion

Optional. The self service update maintenance version.

The version is date based such as "20210712_00_00".

Parameter
Name Description
var string
Returns
Type Description
$this

getAvailableMaintenanceVersions

Optional. The available maintenance versions that an instance could update to.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAvailableMaintenanceVersions

Optional. The available maintenance versions that an instance could update to.

Parameter
Name Description
var string[]
Returns
Type Description
$this