Class ExecuteQueryRequest

    • 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
      • 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)
      • 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