Class GetQueryStateResponse

    • Method Detail

      • error

        public final String error()

        An error message when the operation fails.

        Returns:
        An error message when the operation fails.
      • state

        public final QueryStateString state()

        The state of a query previously submitted. The possible states are:

        • PENDING: the query is pending.

        • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

        • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

        • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.

        If the service returns an enum value that is not available in the current SDK version, state will return QueryStateString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        Returns:
        The state of a query previously submitted. The possible states are:

        • PENDING: the query is pending.

        • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

        • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

        • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.

        See Also:
        QueryStateString
      • stateAsString

        public final String stateAsString()

        The state of a query previously submitted. The possible states are:

        • PENDING: the query is pending.

        • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

        • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

        • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.

        If the service returns an enum value that is not available in the current SDK version, state will return QueryStateString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        Returns:
        The state of a query previously submitted. The possible states are:

        • PENDING: the query is pending.

        • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

        • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

        • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.

        See Also:
        QueryStateString
      • 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