Note: The following fields are mutually exclusive: exclude_replicas, include_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: exclude_replicas, include_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: exclude_replicas, include_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas) — Include_replicas indicates the order of replicas (as they appear in
this list) to process the request. If auto_failover_disabled is set to
true and all replicas are exhausted without finding a healthy replica,
Spanner will wait for a replica in the list to become available, requests
may fail due to DEADLINE_EXCEEDED errors.
Note: The following fields are mutually exclusive: include_replicas, exclude_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.
value (::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas) — Include_replicas indicates the order of replicas (as they appear in
this list) to process the request. If auto_failover_disabled is set to
true and all replicas are exhausted without finding a healthy replica,
Spanner will wait for a replica in the list to become available, requests
may fail due to DEADLINE_EXCEEDED errors.
Note: The following fields are mutually exclusive: include_replicas, exclude_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas) — Include_replicas indicates the order of replicas (as they appear in
this list) to process the request. If auto_failover_disabled is set to
true and all replicas are exhausted without finding a healthy replica,
Spanner will wait for a replica in the list to become available, requests
may fail due to DEADLINE_EXCEEDED errors.
Note: The following fields are mutually exclusive: include_replicas, exclude_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["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 (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)\n- [1.9.1](/ruby/docs/reference/google-cloud-spanner-v1/1.9.1/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.8.0](/ruby/docs/reference/google-cloud-spanner-v1/1.8.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.7.1](/ruby/docs/reference/google-cloud-spanner-v1/1.7.1/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.6.0](/ruby/docs/reference/google-cloud-spanner-v1/1.6.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.5.0](/ruby/docs/reference/google-cloud-spanner-v1/1.5.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.4.0](/ruby/docs/reference/google-cloud-spanner-v1/1.4.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.3.0](/ruby/docs/reference/google-cloud-spanner-v1/1.3.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.2.0](/ruby/docs/reference/google-cloud-spanner-v1/1.2.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.1.0](/ruby/docs/reference/google-cloud-spanner-v1/1.1.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [1.0.2](/ruby/docs/reference/google-cloud-spanner-v1/1.0.2/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.27.0](/ruby/docs/reference/google-cloud-spanner-v1/0.27.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.26.0](/ruby/docs/reference/google-cloud-spanner-v1/0.26.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.25.0](/ruby/docs/reference/google-cloud-spanner-v1/0.25.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.24.0](/ruby/docs/reference/google-cloud-spanner-v1/0.24.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.23.0](/ruby/docs/reference/google-cloud-spanner-v1/0.23.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.22.2](/ruby/docs/reference/google-cloud-spanner-v1/0.22.2/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.21.0](/ruby/docs/reference/google-cloud-spanner-v1/0.21.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.20.1](/ruby/docs/reference/google-cloud-spanner-v1/0.20.1/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.19.0](/ruby/docs/reference/google-cloud-spanner-v1/0.19.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.18.0](/ruby/docs/reference/google-cloud-spanner-v1/0.18.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.17.0](/ruby/docs/reference/google-cloud-spanner-v1/0.17.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.16.0](/ruby/docs/reference/google-cloud-spanner-v1/0.16.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.15.1](/ruby/docs/reference/google-cloud-spanner-v1/0.15.1/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.14.1](/ruby/docs/reference/google-cloud-spanner-v1/0.14.1/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.13.0](/ruby/docs/reference/google-cloud-spanner-v1/0.13.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.12.0](/ruby/docs/reference/google-cloud-spanner-v1/0.12.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.11.0](/ruby/docs/reference/google-cloud-spanner-v1/0.11.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.10.0](/ruby/docs/reference/google-cloud-spanner-v1/0.10.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.9.0](/ruby/docs/reference/google-cloud-spanner-v1/0.9.0/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.8.1](/ruby/docs/reference/google-cloud-spanner-v1/0.8.1/Google-Cloud-Spanner-V1-DirectedReadOptions)\n- [0.7.4](/ruby/docs/reference/google-cloud-spanner-v1/0.7.4/Google-Cloud-Spanner-V1-DirectedReadOptions) \nReference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::DirectedReadOptions.\n\nThe DirectedReadOptions can be used to indicate which replicas or regions\nshould be used for non-transactional reads or queries.\n\n\n\u003cbr /\u003e\n\nDirectedReadOptions may only be specified for a read-only transaction,\notherwise the API will return an `INVALID_ARGUMENT` error. \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### #exclude_replicas\n\n def exclude_replicas() -\u003e ::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas\n\n**Returns**\n\n- ([::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas](./Google-Cloud-Spanner-V1-DirectedReadOptions-ExcludeReplicas)) --- Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.\n\n\n Note: The following fields are mutually exclusive: `exclude_replicas`, `include_replicas`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #exclude_replicas=\n\n def exclude_replicas=(value) -\u003e ::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas](./Google-Cloud-Spanner-V1-DirectedReadOptions-ExcludeReplicas)) --- Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.\n\n\nNote: The following fields are mutually exclusive: `exclude_replicas`, `include_replicas`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas](./Google-Cloud-Spanner-V1-DirectedReadOptions-ExcludeReplicas)) --- Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.\n\n\n Note: The following fields are mutually exclusive: `exclude_replicas`, `include_replicas`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #include_replicas\n\n def include_replicas() -\u003e ::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas\n\n**Returns**\n\n- ([::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas](./Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)) --- Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors.\n\n\n Note: The following fields are mutually exclusive: `include_replicas`, `exclude_replicas`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #include_replicas=\n\n def include_replicas=(value) -\u003e ::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas](./Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)) --- Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors.\n\n\nNote: The following fields are mutually exclusive: `include_replicas`, `exclude_replicas`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas](./Google-Cloud-Spanner-V1-DirectedReadOptions-IncludeReplicas)) --- Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors.\n\n\n Note: The following fields are mutually exclusive: `include_replicas`, `exclude_replicas`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
