Struct aws_sdk_neptunedata::operation::execute_gremlin_query::builders::ExecuteGremlinQueryFluentBuilder

pub struct ExecuteGremlinQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ExecuteGremlinQuery.

This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

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 enables 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 ExecuteGremlinQueryFluentBuilder

pub fn as_input(&self) -> &ExecuteGremlinQueryInputBuilder

Access the ExecuteGremlinQuery as a reference.

pub async fn send( self ) -> Result<ExecuteGremlinQueryOutput, SdkError<ExecuteGremlinQueryError, 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<ExecuteGremlinQueryOutput, ExecuteGremlinQueryError, 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

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 Tinkerpop client section to determine which Gremlin releases your engine version supports).

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

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 Tinkerpop client section to determine which Gremlin releases your engine version supports).

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

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 Tinkerpop client section to determine which Gremlin releases your engine version supports).

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

If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

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

If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

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

If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

Trait Implementations

impl Clone for ExecuteGremlinQueryFluentBuilder

fn clone(&self) -> ExecuteGremlinQueryFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteGremlinQueryFluentBuilder

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

Formats the value using the given formatter.