Struct aws_sdk_neptunedata::operation::execute_gremlin_explain_query::builders::ExecuteGremlinExplainQueryFluentBuilder

pub struct ExecuteGremlinExplainQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ExecuteGremlinExplainQuery.

Executes a Gremlin Explain query.

Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an explain parameter to an HTTP call that submits a Gremlin query.

The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, 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-db:ReadDataViaQuery

• neptune-db:WriteDataViaQuery

• neptune-db:DeleteDataViaQuery

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

Implementations

impl ExecuteGremlinExplainQueryFluentBuilder

pub fn as_input(&self) -> &ExecuteGremlinExplainQueryInputBuilder

Access the ExecuteGremlinExplainQuery as a reference.

pub async fn send( self ) -> Result<ExecuteGremlinExplainQueryOutput, SdkError<ExecuteGremlinExplainQueryError, 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<ExecuteGremlinExplainQueryOutput, ExecuteGremlinExplainQueryError, Self>

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

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

The Gremlin explain query string.

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

The Gremlin explain query string.

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

The Gremlin explain query string.

Trait Implementations

impl Clone for ExecuteGremlinExplainQueryFluentBuilder

fn clone(&self) -> ExecuteGremlinExplainQueryFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteGremlinExplainQueryFluentBuilder

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

Formats the value using the given formatter.