Class ExecuteQueryRequest
- 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 interfaceExecuteQueryRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExecuteQueryRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)ExplainModeexplainMode()The explain mode parameter returns a query explain instead of the actual query results.StringexplainModeAsString()The explain mode parameter returns a query explain instead of the actual query results.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)StringgraphIdentifier()The unique identifier of the Neptune Analytics graph.inthashCode()QueryLanguagelanguage()The query language the query is written in.StringlanguageAsString()The query language the query is written in.PlanCacheTypeplanCache()Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.StringplanCacheAsString()Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query.StringqueryString()The query string to be executed.IntegerqueryTimeoutMilliseconds()Specifies the query timeout duration, in milliseconds.List<SdkField<?>>sdkFields()static Class<? extends ExecuteQueryRequest.Builder>serializableBuilderClass()ExecuteQueryRequest.BuildertoBuilder()StringtoString()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,
languagewill returnQueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- 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,
languagewill returnQueryLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The query language the query is written in. Currently only openCypher is supported.
- See Also:
QueryLanguage
-
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
READandUPDATEqueries. 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,
planCachewill returnPlanCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromplanCacheAsString().- 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
READandUPDATEqueries. 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
READandUPDATEqueries. 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,
planCachewill returnPlanCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromplanCacheAsString().- 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
READandUPDATEqueries. 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,
explainModewill returnExplainMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromexplainModeAsString().- 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,
explainModewill returnExplainMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromexplainModeAsString().- 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:
toBuilderin interfaceToCopyableBuilder<ExecuteQueryRequest.Builder,ExecuteQueryRequest>- Specified by:
toBuilderin classNeptuneGraphRequest
-
builder
public static ExecuteQueryRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ExecuteQueryRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-