Interface ListSessionsRequest.Builder
- All Superinterfaces:
AthenaRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<ListSessionsRequest.Builder,
,ListSessionsRequest> SdkBuilder<ListSessionsRequest.Builder,
,ListSessionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListSessionsRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of sessions to return.A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.stateFilter
(String stateFilter) A filter for a specific session state.stateFilter
(SessionState stateFilter) A filter for a specific session state.The workgroup to which the session belongs.Methods inherited from interface software.amazon.awssdk.services.athena.model.AthenaRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
workGroup
The workgroup to which the session belongs.
- Parameters:
workGroup
- The workgroup to which the session belongs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateFilter
A filter for a specific session state. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.CREATED
- The session has been started.IDLE
- The session is able to accept a calculation.BUSY
- The session is processing another task and is unable to accept a calculation.TERMINATING
- The session is in the process of shutting down.TERMINATED
- The session and its resources are no longer running.DEGRADED
- The session has no healthy coordinators.FAILED
- Due to a failure, the session and its resources are no longer running.- Parameters:
stateFilter
- A filter for a specific session state. A description of each state follows.CREATING
- The session is being started, including acquiring resources.CREATED
- The session has been started.IDLE
- The session is able to accept a calculation.BUSY
- The session is processing another task and is unable to accept a calculation.TERMINATING
- The session is in the process of shutting down.TERMINATED
- The session and its resources are no longer running.DEGRADED
- The session has no healthy coordinators.FAILED
- Due to a failure, the session and its resources are no longer running.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stateFilter
A filter for a specific session state. A description of each state follows.
CREATING
- The session is being started, including acquiring resources.CREATED
- The session has been started.IDLE
- The session is able to accept a calculation.BUSY
- The session is processing another task and is unable to accept a calculation.TERMINATING
- The session is in the process of shutting down.TERMINATED
- The session and its resources are no longer running.DEGRADED
- The session has no healthy coordinators.FAILED
- Due to a failure, the session and its resources are no longer running.- Parameters:
stateFilter
- A filter for a specific session state. A description of each state follows.CREATING
- The session is being started, including acquiring resources.CREATED
- The session has been started.IDLE
- The session is able to accept a calculation.BUSY
- The session is processing another task and is unable to accept a calculation.TERMINATING
- The session is in the process of shutting down.TERMINATED
- The session and its resources are no longer running.DEGRADED
- The session has no healthy coordinators.FAILED
- Due to a failure, the session and its resources are no longer running.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The maximum number of sessions to return.
- Parameters:
maxResults
- The maximum number of sessions to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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 theNextToken
from the response object of the previous page call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListSessionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListSessionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-