Struct aws_sdk_neptunedata::operation::execute_gremlin_profile_query::builders::ExecuteGremlinProfileQueryFluentBuilder

pub struct ExecuteGremlinProfileQueryFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ExecuteGremlinProfileQuery.

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.

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 the neptune-db:ReadDataViaQuery IAM action in that cluster.

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 ExecuteGremlinProfileQueryFluentBuilder

pub fn as_input(&self) -> &ExecuteGremlinProfileQueryInputBuilder

Access the ExecuteGremlinProfileQuery as a reference.

pub async fn send( self ) -> Result<ExecuteGremlinProfileQueryOutput, SdkError<ExecuteGremlinProfileQueryError, 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<ExecuteGremlinProfileQueryOutput, ExecuteGremlinProfileQueryError, 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 query string to profile.

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

The Gremlin query string to profile.

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

The Gremlin query string to profile.

pub fn results(self, input: bool) -> Self

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

pub fn set_results(self, input: Option<bool>) -> Self

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

pub fn get_results(&self) -> &Option<bool>

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

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

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

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

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

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

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

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

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

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

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

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

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

pub fn index_ops(self, input: bool) -> Self

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

pub fn set_index_ops(self, input: Option<bool>) -> Self

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

pub fn get_index_ops(&self) -> &Option<bool>

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

Trait Implementations

impl Clone for ExecuteGremlinProfileQueryFluentBuilder

fn clone(&self) -> ExecuteGremlinProfileQueryFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteGremlinProfileQueryFluentBuilder

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

Formats the value using the given formatter.