Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas.
An IncludeReplicas contains a repeated set of ReplicaSelection which
indicates the order in which replicas should be considered.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#auto_failover_disabled
defauto_failover_disabled()->::Boolean
Returns
(::Boolean) — If true, Spanner will not route requests to a replica outside the
include_replicas list when all of the specified replicas are unavailable
or unhealthy. Default value is false.
#auto_failover_disabled=
defauto_failover_disabled=(value)->::Boolean
Parameter
value (::Boolean) — If true, Spanner will not route requests to a replica outside the
include_replicas list when all of the specified replicas are unavailable
or unhealthy. Default value is false.
Returns
(::Boolean) — If true, Spanner will not route requests to a replica outside the
include_replicas list when all of the specified replicas are unavailable
or unhealthy. Default value is false.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas (v1.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.0 (latest)](/ruby/docs/reference/google-cloud-spanner-v1/latest/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.9.1](/ruby/docs/reference/google-cloud-spanner-v1/1.9.1/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.8.0](/ruby/docs/reference/google-cloud-spanner-v1/1.8.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.7.1](/ruby/docs/reference/google-cloud-spanner-v1/1.7.1/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.6.0](/ruby/docs/reference/google-cloud-spanner-v1/1.6.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.5.0](/ruby/docs/reference/google-cloud-spanner-v1/1.5.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.4.0](/ruby/docs/reference/google-cloud-spanner-v1/1.4.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.3.0](/ruby/docs/reference/google-cloud-spanner-v1/1.3.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.2.0](/ruby/docs/reference/google-cloud-spanner-v1/1.2.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.1.0](/ruby/docs/reference/google-cloud-spanner-v1/1.1.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [1.0.2](/ruby/docs/reference/google-cloud-spanner-v1/1.0.2/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.27.0](/ruby/docs/reference/google-cloud-spanner-v1/0.27.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.26.0](/ruby/docs/reference/google-cloud-spanner-v1/0.26.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.25.0](/ruby/docs/reference/google-cloud-spanner-v1/0.25.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.24.0](/ruby/docs/reference/google-cloud-spanner-v1/0.24.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.23.0](/ruby/docs/reference/google-cloud-spanner-v1/0.23.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.22.2](/ruby/docs/reference/google-cloud-spanner-v1/0.22.2/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.21.0](/ruby/docs/reference/google-cloud-spanner-v1/0.21.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.20.1](/ruby/docs/reference/google-cloud-spanner-v1/0.20.1/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.19.0](/ruby/docs/reference/google-cloud-spanner-v1/0.19.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.18.0](/ruby/docs/reference/google-cloud-spanner-v1/0.18.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.17.0](/ruby/docs/reference/google-cloud-spanner-v1/0.17.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.16.0](/ruby/docs/reference/google-cloud-spanner-v1/0.16.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.15.1](/ruby/docs/reference/google-cloud-spanner-v1/0.15.1/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.14.1](/ruby/docs/reference/google-cloud-spanner-v1/0.14.1/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.13.0](/ruby/docs/reference/google-cloud-spanner-v1/0.13.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.12.0](/ruby/docs/reference/google-cloud-spanner-v1/0.12.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.11.0](/ruby/docs/reference/google-cloud-spanner-v1/0.11.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.10.0](/ruby/docs/reference/google-cloud-spanner-v1/0.10.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.9.0](/ruby/docs/reference/google-cloud-spanner-v1/0.9.0/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.8.1](/ruby/docs/reference/google-cloud-spanner-v1/0.8.1/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)\n- [0.7.4](/ruby/docs/reference/google-cloud-spanner-v1/0.7.4/Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas) \nReference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas.\n\nAn IncludeReplicas contains a repeated set of ReplicaSelection which\nindicates the order in which replicas should be considered. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #auto_failover_disabled\n\n def auto_failover_disabled() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`.\n\n### #auto_failover_disabled=\n\n def auto_failover_disabled=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. \n**Returns**\n\n- (::Boolean) --- If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`.\n\n### #replica_selections\n\n def replica_selections() -\u003e ::Array\u003c::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection](./Google-Cloud-Spanner-V1-DirectedReadOptions-ReplicaSelection)\\\u003e) --- The directed read replica selector.\n\n### #replica_selections=\n\n def replica_selections=(value) -\u003e ::Array\u003c::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection](./Google-Cloud-Spanner-V1-DirectedReadOptions-ReplicaSelection)\\\u003e) --- The directed read replica selector. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection](./Google-Cloud-Spanner-V1-DirectedReadOptions-ReplicaSelection)\\\u003e) --- The directed read replica selector."]]