Interface ListTrialsRequest.Builder

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

  • Method Details

    • experimentName

      ListTrialsRequest.Builder experimentName(String experimentName)

      A filter that returns only trials that are part of the specified experiment.

      Parameters:
      experimentName - A filter that returns only trials that are part of the specified experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trialComponentName

      ListTrialsRequest.Builder trialComponentName(String trialComponentName)

      A filter that returns only trials that are associated with the specified trial component.

      Parameters:
      trialComponentName - A filter that returns only trials that are associated with the specified trial component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAfter

      ListTrialsRequest.Builder createdAfter(Instant createdAfter)

      A filter that returns only trials created after the specified time.

      Parameters:
      createdAfter - A filter that returns only trials created after the specified time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBefore

      ListTrialsRequest.Builder createdBefore(Instant createdBefore)

      A filter that returns only trials created before the specified time.

      Parameters:
      createdBefore - A filter that returns only trials created before the specified time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      ListTrialsRequest.Builder sortBy(String sortBy)

      The property used to sort results. The default value is CreationTime.

      Parameters:
      sortBy - The property used to sort results. The default value is CreationTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      ListTrialsRequest.Builder sortBy(SortTrialsBy sortBy)

      The property used to sort results. The default value is CreationTime.

      Parameters:
      sortBy - The property used to sort results. The default value is CreationTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListTrialsRequest.Builder sortOrder(String sortOrder)

      The sort order. The default value is Descending.

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

    • sortOrder

      ListTrialsRequest.Builder sortOrder(SortOrder sortOrder)

      The sort order. The default value is Descending.

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

    • maxResults

      ListTrialsRequest.Builder maxResults(Integer maxResults)

      The maximum number of trials to return in the response. The default value is 10.

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

    • nextToken

      ListTrialsRequest.Builder nextToken(String nextToken)

      If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

      Parameters:
      nextToken - If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListTrialsRequest.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

      ListTrialsRequest.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.