aws_sdk_neptunedata/client/
execute_gremlin_explain_query.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ExecuteGremlinExplainQuery`](crate::operation::execute_gremlin_explain_query::builders::ExecuteGremlinExplainQueryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`gremlin_query(impl Into<String>)`](crate::operation::execute_gremlin_explain_query::builders::ExecuteGremlinExplainQueryFluentBuilder::gremlin_query) / [`set_gremlin_query(Option<String>)`](crate::operation::execute_gremlin_explain_query::builders::ExecuteGremlinExplainQueryFluentBuilder::set_gremlin_query):<br>required: **true**<br><p>The Gremlin explain query string.</p><br>
7    /// - On success, responds with [`ExecuteGremlinExplainQueryOutput`](crate::operation::execute_gremlin_explain_query::ExecuteGremlinExplainQueryOutput) with field(s):
8    ///   - [`output(Option<Blob>)`](crate::operation::execute_gremlin_explain_query::ExecuteGremlinExplainQueryOutput::output): <p>A text blob containing the Gremlin explain result, as described in <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html">Tuning Gremlin queries</a>.</p>
9    /// - On failure, responds with [`SdkError<ExecuteGremlinExplainQueryError>`](crate::operation::execute_gremlin_explain_query::ExecuteGremlinExplainQueryError)
10    pub fn execute_gremlin_explain_query(
11        &self,
12    ) -> crate::operation::execute_gremlin_explain_query::builders::ExecuteGremlinExplainQueryFluentBuilder {
13        crate::operation::execute_gremlin_explain_query::builders::ExecuteGremlinExplainQueryFluentBuilder::new(self.handle.clone())
14    }
15}