Exclude_replicas indicates that specified replicas should be excluded
from serving requests. Spanner will not route requests to the replicas
in this list.
Exclude_replicas indicates that specified replicas should be excluded
from serving requests. Spanner will not route requests to the replicas
in this list.
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.
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.
Exclude_replicas indicates that specified replicas should be excluded
from serving requests. Spanner will not route requests to the replicas
in this list.
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.
[[["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-09-04 UTC."],[],[],null,["# Interface DirectedReadOptionsOrBuilder (6.98.1)\n\nVersion latestkeyboard_arrow_down\n\n- [6.98.1 (latest)](/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.98.0](/java/docs/reference/google-cloud-spanner/6.98.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.97.1](/java/docs/reference/google-cloud-spanner/6.97.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.96.1](/java/docs/reference/google-cloud-spanner/6.96.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.95.1](/java/docs/reference/google-cloud-spanner/6.95.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.94.0](/java/docs/reference/google-cloud-spanner/6.94.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.93.0](/java/docs/reference/google-cloud-spanner/6.93.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.89.0](/java/docs/reference/google-cloud-spanner/6.89.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.88.0](/java/docs/reference/google-cloud-spanner/6.88.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.87.0](/java/docs/reference/google-cloud-spanner/6.87.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.86.0](/java/docs/reference/google-cloud-spanner/6.86.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.85.0](/java/docs/reference/google-cloud-spanner/6.85.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.83.0](/java/docs/reference/google-cloud-spanner/6.83.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.82.0](/java/docs/reference/google-cloud-spanner/6.82.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.80.1](/java/docs/reference/google-cloud-spanner/6.80.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.79.0](/java/docs/reference/google-cloud-spanner/6.79.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.77.0](/java/docs/reference/google-cloud-spanner/6.77.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.74.1](/java/docs/reference/google-cloud-spanner/6.74.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.72.0](/java/docs/reference/google-cloud-spanner/6.72.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.71.0](/java/docs/reference/google-cloud-spanner/6.71.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.69.0](/java/docs/reference/google-cloud-spanner/6.69.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.68.0](/java/docs/reference/google-cloud-spanner/6.68.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.66.0](/java/docs/reference/google-cloud-spanner/6.66.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.65.1](/java/docs/reference/google-cloud-spanner/6.65.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.62.0](/java/docs/reference/google-cloud-spanner/6.62.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.60.0](/java/docs/reference/google-cloud-spanner/6.60.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.58.0](/java/docs/reference/google-cloud-spanner/6.58.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.57.0](/java/docs/reference/google-cloud-spanner/6.57.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.56.0](/java/docs/reference/google-cloud-spanner/6.56.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.55.0](/java/docs/reference/google-cloud-spanner/6.55.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.54.0](/java/docs/reference/google-cloud-spanner/6.54.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.53.0](/java/docs/reference/google-cloud-spanner/6.53.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.52.1](/java/docs/reference/google-cloud-spanner/6.52.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.51.0](/java/docs/reference/google-cloud-spanner/6.51.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.50.1](/java/docs/reference/google-cloud-spanner/6.50.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.49.0](/java/docs/reference/google-cloud-spanner/6.49.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.25.1](/java/docs/reference/google-cloud-spanner/6.25.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.24.0](/java/docs/reference/google-cloud-spanner/6.24.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.23.4](/java/docs/reference/google-cloud-spanner/6.23.4/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.22.0](/java/docs/reference/google-cloud-spanner/6.22.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.21.2](/java/docs/reference/google-cloud-spanner/6.21.2/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.20.0](/java/docs/reference/google-cloud-spanner/6.20.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.19.1](/java/docs/reference/google-cloud-spanner/6.19.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.18.0](/java/docs/reference/google-cloud-spanner/6.18.0/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.17.4](/java/docs/reference/google-cloud-spanner/6.17.4/com.google.spanner.v1.DirectedReadOptionsOrBuilder)\n- [6.14.1](/java/docs/reference/google-cloud-spanner/6.14.1/com.google.spanner.v1.DirectedReadOptionsOrBuilder) \n\n public interface DirectedReadOptionsOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getExcludeReplicas()\n\n public abstract DirectedReadOptions.ExcludeReplicas getExcludeReplicas()\n\nExclude_replicas indicates that specified replicas should be excluded\nfrom serving requests. Spanner will not route requests to the replicas\nin this list.\n\n`.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;`\n\n### getExcludeReplicasOrBuilder()\n\n public abstract DirectedReadOptions.ExcludeReplicasOrBuilder getExcludeReplicasOrBuilder()\n\nExclude_replicas indicates that specified replicas should be excluded\nfrom serving requests. Spanner will not route requests to the replicas\nin this list.\n\n`.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;`\n\n### getIncludeReplicas()\n\n public abstract DirectedReadOptions.IncludeReplicas getIncludeReplicas()\n\nInclude_replicas indicates the order of replicas (as they appear in\nthis list) to process the request. If auto_failover_disabled is set to\ntrue and all replicas are exhausted without finding a healthy replica,\nSpanner will wait for a replica in the list to become available, requests\nmay fail due to `DEADLINE_EXCEEDED` errors.\n\n`.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;`\n\n### getIncludeReplicasOrBuilder()\n\n public abstract DirectedReadOptions.IncludeReplicasOrBuilder getIncludeReplicasOrBuilder()\n\nInclude_replicas indicates the order of replicas (as they appear in\nthis list) to process the request. If auto_failover_disabled is set to\ntrue and all replicas are exhausted without finding a healthy replica,\nSpanner will wait for a replica in the list to become available, requests\nmay fail due to `DEADLINE_EXCEEDED` errors.\n\n`.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;`\n\n### getReplicasCase()\n\n public abstract DirectedReadOptions.ReplicasCase getReplicasCase()\n\n### hasExcludeReplicas()\n\n public abstract boolean hasExcludeReplicas()\n\nExclude_replicas indicates that specified replicas should be excluded\nfrom serving requests. Spanner will not route requests to the replicas\nin this list.\n\n`.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;`\n\n### hasIncludeReplicas()\n\n public abstract boolean hasIncludeReplicas()\n\nInclude_replicas indicates the order of replicas (as they appear in\nthis list) to process the request. If auto_failover_disabled is set to\ntrue and all replicas are exhausted without finding a healthy replica,\nSpanner will wait for a replica in the list to become available, requests\nmay fail due to `DEADLINE_EXCEEDED` errors.\n\n`.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;`"]]
