1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ExecuteGremlinQuery`](crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`gremlin_query(impl Into<String>)`](crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder::gremlin_query) / [`set_gremlin_query(Option<String>)`](crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder::set_gremlin_query):<br>required: **true**<br><p>Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest">Tinkerpop client section</a> to determine which Gremlin releases your engine version supports).</p><br>
    ///   - [`serializer(impl Into<String>)`](crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder::serializer) / [`set_serializer(Option<String>)`](crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder::set_serializer):<br>required: **false**<br><p>If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the <a href="https://tinkerpop.apache.org/docs/current/reference/#_graphson">GraphSON</a> section in the TinkerPop documentation for a list of the formats that are currently supported.</p><br>
    /// - On success, responds with [`ExecuteGremlinQueryOutput`](crate::operation::execute_gremlin_query::ExecuteGremlinQueryOutput) with field(s):
    ///   - [`request_id(Option<String>)`](crate::operation::execute_gremlin_query::ExecuteGremlinQueryOutput::request_id): <p>The unique identifier of the Gremlin query.</p>
    ///   - [`status(Option<GremlinQueryStatusAttributes>)`](crate::operation::execute_gremlin_query::ExecuteGremlinQueryOutput::status): <p>The status of the Gremlin query.</p>
    ///   - [`result(Option<Document>)`](crate::operation::execute_gremlin_query::ExecuteGremlinQueryOutput::result): <p>The Gremlin query output from the server.</p>
    ///   - [`meta_value(Option<Document>)`](crate::operation::execute_gremlin_query::ExecuteGremlinQueryOutput::meta_value): <p>Metadata about the Gremlin query.</p>
    /// - On failure, responds with [`SdkError<ExecuteGremlinQueryError>`](crate::operation::execute_gremlin_query::ExecuteGremlinQueryError)
    pub fn execute_gremlin_query(&self) -> crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder {
        crate::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder::new(self.handle.clone())
    }
}