java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.neptunegraph.model.NeptuneGraphRequest
    - - software.amazon.awssdk.services.neptunegraph.model.ExecuteQueryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ExecuteQueryRequest
extends NeptuneGraphRequest
implements ToCopyableBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ExecuteQueryRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ExecuteQueryRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExplainMode`	`explainMode()`	The explain mode parameter returns a query explain instead of the actual query results.
`String`	`explainModeAsString()`	The explain mode parameter returns a query explain instead of the actual query results.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`graphIdentifier()`	The unique identifier of the Neptune Analytics graph.
`int`	`hashCode()`
`boolean`	`hasParameters()`	For responses, this returns true if the service returned a value for the Parameters property.
`QueryLanguage`	`language()`	The query language the query is written in.
`String`	`languageAsString()`	The query language the query is written in.
`Map<String,Document>`	`parameters()`	The data parameters the query can use in JSON format.
`PlanCacheType`	`planCache()`	Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.
`String`	`planCacheAsString()`	Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.
`String`	`queryString()`	The query string to be executed.
`Integer`	`queryTimeoutMilliseconds()`	Specifies the query timeout duration, in milliseconds.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ExecuteQueryRequest.Builder>`	`serializableBuilderClass()`
`ExecuteQueryRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - graphIdentifier
```
public final String graphIdentifier()
```
    The unique identifier of the Neptune Analytics graph.
    
    Returns:
    
    The unique identifier of the Neptune Analytics graph.
  - queryString
```
public final String queryString()
```
    The query string to be executed.
    
    Returns:
    
    The query string to be executed.
  - language
```
public final QueryLanguage language()
```
    The query language the query is written in. Currently only openCypher is supported.
    
    If the service returns an enum value that is not available in the current SDK version, language will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageAsString().
    
    Returns:
    
    The query language the query is written in. Currently only openCypher is supported.
    
    See Also:
    
    QueryLanguage
  - languageAsString
```
public final String languageAsString()
```
    The query language the query is written in. Currently only openCypher is supported.
    
    If the service returns an enum value that is not available in the current SDK version, language will return QueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageAsString().
    
    Returns:
    
    The query language the query is written in. Currently only openCypher is supported.
    
    See Also:
    
    QueryLanguage
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final Map<String,Document> parameters()
```
    The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    Returns:
    
    The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)
  - planCache
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, planCache will return PlanCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from planCacheAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PlanCacheType
  - planCacheAsString
```
public final String planCacheAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, planCache will return PlanCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from planCacheAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PlanCacheType
  - explainMode
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, explainMode will return ExplainMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from explainModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ExplainMode
  - explainModeAsString
```
public final String explainModeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, explainMode will return ExplainMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from explainModeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ExplainMode
  - queryTimeoutMilliseconds
```
public final Integer queryTimeoutMilliseconds()
```
    Specifies the query timeout duration, in milliseconds. (optional)
    
    Returns:
    
    Specifies the query timeout duration, in milliseconds. (optional)
  - toBuilder
```
public ExecuteQueryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>
    
    Specified by:
    
    toBuilder in class NeptuneGraphRequest
  - builder
```
public static ExecuteQueryRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ExecuteQueryRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ExecuteQueryRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

graphIdentifier

queryString

language

languageAsString

hasParameters

parameters

planCache

planCacheAsString

explainMode

explainModeAsString

queryTimeoutMilliseconds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields