Struct ExecuteQueryFluentBuilder

pub struct ExecuteQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ExecuteQuery.

Execute an openCypher query.

When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:

• neptune-graph:ReadDataViaQuery

• neptune-graph:WriteDataViaQuery

• neptune-graph:DeleteDataViaQuery

Implementations

impl ExecuteQueryFluentBuilder

pub fn as_input(&self) -> &ExecuteQueryInputBuilder

Access the ExecuteQuery as a reference.

pub async fn send( self, ) -> Result<ExecuteQueryOutput, SdkError<ExecuteQueryError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<ExecuteQueryOutput, ExecuteQueryError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn graph_identifier(self, input: impl Into<String>) -> Self

The unique identifier of the Neptune Analytics graph.

pub fn set_graph_identifier(self, input: Option<String>) -> Self

The unique identifier of the Neptune Analytics graph.

pub fn get_graph_identifier(&self) -> &Option<String>

The unique identifier of the Neptune Analytics graph.

pub fn query_string(self, input: impl Into<String>) -> Self

The query string to be executed.

pub fn set_query_string(self, input: Option<String>) -> Self

The query string to be executed.

pub fn get_query_string(&self) -> &Option<String>

The query string to be executed.

pub fn language(self, input: QueryLanguage) -> Self

The query language the query is written in. Currently only openCypher is supported.

pub fn set_language(self, input: Option<QueryLanguage>) -> Self

The query language the query is written in. Currently only openCypher is supported.

pub fn get_language(&self) -> &Option<QueryLanguage>

The query language the query is written in. Currently only openCypher is supported.

pub fn parameters(self, k: impl Into<String>, v: Document) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

pub fn set_parameters(self, input: Option<HashMap<String, Document>>) -> Self

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

pub fn get_parameters(&self) -> &Option<HashMap<String, Document>>

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

pub fn plan_cache(self, input: PlanCacheType) -> Self

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

pub fn set_plan_cache(self, input: Option<PlanCacheType>) -> Self

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

pub fn get_plan_cache(&self) -> &Option<PlanCacheType>

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

pub fn explain_mode(self, input: ExplainMode) -> Self

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

pub fn set_explain_mode(self, input: Option<ExplainMode>) -> Self

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

pub fn get_explain_mode(&self) -> &Option<ExplainMode>

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

pub fn query_timeout_milliseconds(self, input: i32) -> Self

Specifies the query timeout duration, in milliseconds. (optional)

pub fn set_query_timeout_milliseconds(self, input: Option<i32>) -> Self

Specifies the query timeout duration, in milliseconds. (optional)

pub fn get_query_timeout_milliseconds(&self) -> &Option<i32>

Specifies the query timeout duration, in milliseconds. (optional)

Trait Implementations

impl Clone for ExecuteQueryFluentBuilder

fn clone(&self) -> ExecuteQueryFluentBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecuteQueryFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.