Package software.amazon.awssdk.services.neptunegraph.model

Interface ExecuteQueryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>, NeptuneGraphRequest.Builder, SdkBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ExecuteQueryRequest
public static interface ExecuteQueryRequest.Builder extends NeptuneGraphRequest.Builder, SdkPojo, CopyableBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>

  • Method Details

    • graphIdentifier

      ExecuteQueryRequest.Builder graphIdentifier(String graphIdentifier)

      The unique identifier of the Neptune Analytics graph.

      Parameters:
      graphIdentifier - The unique identifier of the Neptune Analytics graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryString

      ExecuteQueryRequest.Builder queryString(String queryString)

      The query string to be executed.

      Parameters:
      queryString - The query string to be executed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • language

      ExecuteQueryRequest.Builder language(String language)

      The query language the query is written in. Currently only openCypher is supported.

      Parameters:
      language - The query language the query is written in. Currently only openCypher is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • language

      ExecuteQueryRequest.Builder language(QueryLanguage language)

      The query language the query is written in. Currently only openCypher is supported.

      Parameters:
      language - The query language the query is written in. Currently only openCypher is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • parameters

      ExecuteQueryRequest.Builder parameters(Map<String,Document> parameters)

      The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

      Parameters:
      parameters - The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • planCache

      ExecuteQueryRequest.Builder planCache(String planCache)

      Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

      Parameters:
      planCache - Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • planCache

      ExecuteQueryRequest.Builder planCache(PlanCacheType planCache)

      Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

      Parameters:
      planCache - Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both READ and UPDATE queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • explainMode

      ExecuteQueryRequest.Builder explainMode(String explainMode)

      The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

      Parameters:
      explainMode - The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • explainMode

      ExecuteQueryRequest.Builder explainMode(ExplainMode explainMode)

      The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

      Parameters:
      explainMode - The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryTimeoutMilliseconds

      ExecuteQueryRequest.Builder queryTimeoutMilliseconds(Integer queryTimeoutMilliseconds)

      Specifies the query timeout duration, in milliseconds. (optional)

      Parameters:
      queryTimeoutMilliseconds - Specifies the query timeout duration, in milliseconds. (optional)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ExecuteQueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ExecuteQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.