Class ListExecutorsRequest

    • Method Detail

      • sessionId

        public final String sessionId()

        The session ID.

        Returns:
        The session ID.
      • executorStateFilter

        public final ExecutorState executorStateFilter()

        A filter for a specific executor state. A description of each state follows.

        CREATING - The executor is being started, including acquiring resources.

        CREATED - The executor has been started.

        REGISTERED - The executor has been registered.

        TERMINATING - The executor is in the process of shutting down.

        TERMINATED - The executor is no longer running.

        FAILED - Due to a failure, the executor is no longer running.

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

        Returns:
        A filter for a specific executor state. A description of each state follows.

        CREATING - The executor is being started, including acquiring resources.

        CREATED - The executor has been started.

        REGISTERED - The executor has been registered.

        TERMINATING - The executor is in the process of shutting down.

        TERMINATED - The executor is no longer running.

        FAILED - Due to a failure, the executor is no longer running.

        See Also:
        ExecutorState
      • executorStateFilterAsString

        public final String executorStateFilterAsString()

        A filter for a specific executor state. A description of each state follows.

        CREATING - The executor is being started, including acquiring resources.

        CREATED - The executor has been started.

        REGISTERED - The executor has been registered.

        TERMINATING - The executor is in the process of shutting down.

        TERMINATED - The executor is no longer running.

        FAILED - Due to a failure, the executor is no longer running.

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

        Returns:
        A filter for a specific executor state. A description of each state follows.

        CREATING - The executor is being started, including acquiring resources.

        CREATED - The executor has been started.

        REGISTERED - The executor has been registered.

        TERMINATING - The executor is in the process of shutting down.

        TERMINATED - The executor is no longer running.

        FAILED - Due to a failure, the executor is no longer running.

        See Also:
        ExecutorState
      • maxResults

        public final Integer maxResults()

        The maximum number of executors to return.

        Returns:
        The maximum number of executors to return.
      • nextToken

        public final String nextToken()

        A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

        Returns:
        A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
      • 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