Option for google::cloud::Options to indicate which replicas or regions should be used for reads/queries in read-only or single-use transactions.
Use of DirectedReadOptions within a read-write transaction will result in a kInvalidArgument error.
The IncludeReplicas variant lists the replicas to try (in order) to process the request, and what to do if the list is exhausted without finding a healthy replica.
Alternately, the ExcludeReplicas variant lists replicas that should be excluded from serving the request.
Type Aliases
Type
Alias Of: absl::variant< absl::monostate, IncludeReplicas, ExcludeReplicas >
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["This document provides a list of available versions for `DirectedReadOption`, ranging from the latest release candidate, `2.37.0-rc`, down to version `2.11.0`."],["`DirectedReadOption` is used to specify which replicas or regions should handle read-only or single-use transaction queries."],["The `IncludeReplicas` option lists the order of replicas to use for request processing and actions to take if the list is exhausted."],["The `ExcludeReplicas` option lists replicas that should be avoided for serving the request."],["Using `DirectedReadOptions` in a read-write transaction will trigger a `kInvalidArgument` error."]]],[]]
