Package software.amazon.awssdk.services.sagemaker.model

Interface ListClusterNodesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListClusterNodesRequest.Builder,ListClusterNodesRequest>, SageMakerRequest.Builder, SdkBuilder<ListClusterNodesRequest.Builder,ListClusterNodesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListClusterNodesRequest
public static interface ListClusterNodesRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<ListClusterNodesRequest.Builder,ListClusterNodesRequest>

  • Method Details

    • clusterName

      ListClusterNodesRequest.Builder clusterName(String clusterName)

      The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

      Parameters:
      clusterName - The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTimeAfter

      ListClusterNodesRequest.Builder creationTimeAfter(Instant creationTimeAfter)

      A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

      Acceptable formats include:

      • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

      • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

      • YYYY-MM-DD, for example, 2014-10-01

      • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

      For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

      Parameters:
      creationTimeAfter - A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

      Acceptable formats include:

      • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

      • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

      • YYYY-MM-DD, for example, 2014-10-01

      • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

      For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTimeBefore

      ListClusterNodesRequest.Builder creationTimeBefore(Instant creationTimeBefore)

      A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

      Parameters:
      creationTimeBefore - A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceGroupNameContains

      ListClusterNodesRequest.Builder instanceGroupNameContains(String instanceGroupNameContains)

      A filter that returns the instance groups whose name contain a specified string.

      Parameters:
      instanceGroupNameContains - A filter that returns the instance groups whose name contain a specified string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListClusterNodesRequest.Builder maxResults(Integer maxResults)

      The maximum number of nodes to return in the response.

      Parameters:
      maxResults - The maximum number of nodes to return in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListClusterNodesRequest.Builder nextToken(String nextToken)

      If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

      Parameters:
      nextToken - If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      ListClusterNodesRequest.Builder sortBy(String sortBy)

      The field by which to sort results. The default value is CREATION_TIME.

      Parameters:
      sortBy - The field by which to sort results. The default value is CREATION_TIME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      ListClusterNodesRequest.Builder sortBy(ClusterSortBy sortBy)

      The field by which to sort results. The default value is CREATION_TIME.

      Parameters:
      sortBy - The field by which to sort results. The default value is CREATION_TIME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListClusterNodesRequest.Builder sortOrder(String sortOrder)

      The sort order for results. The default value is Ascending.

      Parameters:
      sortOrder - The sort order for results. The default value is Ascending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListClusterNodesRequest.Builder sortOrder(SortOrder sortOrder)

      The sort order for results. The default value is Ascending.

      Parameters:
      sortOrder - The sort order for results. The default value is Ascending.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListClusterNodesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListClusterNodesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.