Interface ListClusterEventsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListClusterEventsRequest.Builder,,ListClusterEventsRequest> SageMakerRequest.Builder,SdkBuilder<ListClusterEventsRequest.Builder,,ListClusterEventsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListClusterEventsRequest
-
Method Summary
Modifier and TypeMethodDescriptionclusterName(String clusterName) The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.eventTimeAfter(Instant eventTimeAfter) The start of the time range for filtering events.eventTimeBefore(Instant eventTimeBefore) The end of the time range for filtering events.instanceGroupName(String instanceGroupName) The name of the instance group to filter events.maxResults(Integer maxResults) The maximum number of events to return in the response.A token to retrieve the next set of results.The EC2 instance ID to filter events.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceType(String resourceType) The type of resource for which to filter events.resourceType(ClusterEventResourceType resourceType) The type of resource for which to filter events.The field to use for sorting the event list.sortBy(EventSortBy sortBy) The field to use for sorting the event list.The order in which to sort the results.The order in which to sort the results.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
clusterName
The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.
- Parameters:
clusterName- The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceGroupName
The name of the instance group to filter events. If specified, only events related to this instance group are returned.
- Parameters:
instanceGroupName- The name of the instance group to filter events. If specified, only events related to this instance group are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeId
The EC2 instance ID to filter events. If specified, only events related to this instance are returned.
- Parameters:
nodeId- The EC2 instance ID to filter events. If specified, only events related to this instance are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventTimeAfter
The start of the time range for filtering events. Only events that occurred after this time are included in the results.
- Parameters:
eventTimeAfter- The start of the time range for filtering events. Only events that occurred after this time are included in the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventTimeBefore
The end of the time range for filtering events. Only events that occurred before this time are included in the results.
- Parameters:
eventTimeBefore- The end of the time range for filtering events. Only events that occurred before this time are included in the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
The field to use for sorting the event list. Currently, the only supported value is
EventTime.- Parameters:
sortBy- The field to use for sorting the event list. Currently, the only supported value isEventTime.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortBy
The field to use for sorting the event list. Currently, the only supported value is
EventTime.- Parameters:
sortBy- The field to use for sorting the event list. Currently, the only supported value isEventTime.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending).- Parameters:
sortOrder- The order in which to sort the results. Valid values areAscendingorDescending(the default isDescending).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending).- Parameters:
sortOrder- The order in which to sort the results. Valid values areAscendingorDescending(the default isDescending).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceType
The type of resource for which to filter events. Valid values are
Cluster,InstanceGroup, orInstance.- Parameters:
resourceType- The type of resource for which to filter events. Valid values areCluster,InstanceGroup, orInstance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceType
The type of resource for which to filter events. Valid values are
Cluster,InstanceGroup, orInstance.- Parameters:
resourceType- The type of resource for which to filter events. Valid values areCluster,InstanceGroup, orInstance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The maximum number of events to return in the response. Valid range is 1 to 100.
- Parameters:
maxResults- The maximum number of events to return in the response. Valid range is 1 to 100.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
A token to retrieve the next set of results. This token is obtained from the output of a previous
ListClusterEventscall.- Parameters:
nextToken- A token to retrieve the next set of results. This token is obtained from the output of a previousListClusterEventscall.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListClusterEventsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListClusterEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-