software.amazon.awssdk.services.sagemaker.model.ListTrialsRequest Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListTrialsRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField EXPERIMENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExperimentName").getter(getter(ListTrialsRequest::experimentName))
.setter(setter(Builder::experimentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExperimentName").build()).build();
private static final SdkField TRIAL_COMPONENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TrialComponentName").getter(getter(ListTrialsRequest::trialComponentName))
.setter(setter(Builder::trialComponentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrialComponentName").build())
.build();
private static final SdkField CREATED_AFTER_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedAfter").getter(getter(ListTrialsRequest::createdAfter)).setter(setter(Builder::createdAfter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedAfter").build()).build();
private static final SdkField CREATED_BEFORE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedBefore").getter(getter(ListTrialsRequest::createdBefore)).setter(setter(Builder::createdBefore))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedBefore").build()).build();
private static final SdkField SORT_BY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("SortBy")
.getter(getter(ListTrialsRequest::sortByAsString)).setter(setter(Builder::sortBy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortBy").build()).build();
private static final SdkField SORT_ORDER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SortOrder").getter(getter(ListTrialsRequest::sortOrderAsString)).setter(setter(Builder::sortOrder))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortOrder").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListTrialsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListTrialsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EXPERIMENT_NAME_FIELD,
TRIAL_COMPONENT_NAME_FIELD, CREATED_AFTER_FIELD, CREATED_BEFORE_FIELD, SORT_BY_FIELD, SORT_ORDER_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private final String experimentName;
private final String trialComponentName;
private final Instant createdAfter;
private final Instant createdBefore;
private final String sortBy;
private final String sortOrder;
private final Integer maxResults;
private final String nextToken;
private ListTrialsRequest(BuilderImpl builder) {
super(builder);
this.experimentName = builder.experimentName;
this.trialComponentName = builder.trialComponentName;
this.createdAfter = builder.createdAfter;
this.createdBefore = builder.createdBefore;
this.sortBy = builder.sortBy;
this.sortOrder = builder.sortOrder;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
*
* A filter that returns only trials that are part of the specified experiment.
*
*
* @return A filter that returns only trials that are part of the specified experiment.
*/
public final String experimentName() {
return experimentName;
}
/**
*
* A filter that returns only trials that are associated with the specified trial component.
*
*
* @return A filter that returns only trials that are associated with the specified trial component.
*/
public final String trialComponentName() {
return trialComponentName;
}
/**
*
* A filter that returns only trials created after the specified time.
*
*
* @return A filter that returns only trials created after the specified time.
*/
public final Instant createdAfter() {
return createdAfter;
}
/**
*
* A filter that returns only trials created before the specified time.
*
*
* @return A filter that returns only trials created before the specified time.
*/
public final Instant createdBefore() {
return createdBefore;
}
/**
*
* The property used to sort results. The default value is CreationTime.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link SortTrialsBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortByAsString}.
*
*
* @return The property used to sort results. The default value is CreationTime.
* @see SortTrialsBy
*/
public final SortTrialsBy sortBy() {
return SortTrialsBy.fromValue(sortBy);
}
/**
*
* The property used to sort results. The default value is CreationTime.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link SortTrialsBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortByAsString}.
*
*
* @return The property used to sort results. The default value is CreationTime.
* @see SortTrialsBy
*/
public final String sortByAsString() {
return sortBy;
}
/**
*
* The sort order. The default value is Descending.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return The sort order. The default value is Descending.
* @see SortOrder
*/
public final SortOrder sortOrder() {
return SortOrder.fromValue(sortOrder);
}
/**
*
* The sort order. The default value is Descending.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return The sort order. The default value is Descending.
* @see SortOrder
*/
public final String sortOrderAsString() {
return sortOrder;
}
/**
*
* The maximum number of trials to return in the response. The default value is 10.
*
*
* @return The maximum number of trials to return in the response. The default value is 10.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(experimentName());
hashCode = 31 * hashCode + Objects.hashCode(trialComponentName());
hashCode = 31 * hashCode + Objects.hashCode(createdAfter());
hashCode = 31 * hashCode + Objects.hashCode(createdBefore());
hashCode = 31 * hashCode + Objects.hashCode(sortByAsString());
hashCode = 31 * hashCode + Objects.hashCode(sortOrderAsString());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListTrialsRequest)) {
return false;
}
ListTrialsRequest other = (ListTrialsRequest) obj;
return Objects.equals(experimentName(), other.experimentName())
&& Objects.equals(trialComponentName(), other.trialComponentName())
&& Objects.equals(createdAfter(), other.createdAfter()) && Objects.equals(createdBefore(), other.createdBefore())
&& Objects.equals(sortByAsString(), other.sortByAsString())
&& Objects.equals(sortOrderAsString(), other.sortOrderAsString())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ListTrialsRequest").add("ExperimentName", experimentName())
.add("TrialComponentName", trialComponentName()).add("CreatedAfter", createdAfter())
.add("CreatedBefore", createdBefore()).add("SortBy", sortByAsString()).add("SortOrder", sortOrderAsString())
.add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ExperimentName":
return Optional.ofNullable(clazz.cast(experimentName()));
case "TrialComponentName":
return Optional.ofNullable(clazz.cast(trialComponentName()));
case "CreatedAfter":
return Optional.ofNullable(clazz.cast(createdAfter()));
case "CreatedBefore":
return Optional.ofNullable(clazz.cast(createdBefore()));
case "SortBy":
return Optional.ofNullable(clazz.cast(sortByAsString()));
case "SortOrder":
return Optional.ofNullable(clazz.cast(sortOrderAsString()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListTrialsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A filter that returns only trials that are part of the specified experiment.
*
*
* @param experimentName
* A filter that returns only trials that are part of the specified experiment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder experimentName(String experimentName);
/**
*
* A filter that returns only trials that are associated with the specified trial component.
*
*
* @param trialComponentName
* A filter that returns only trials that are associated with the specified trial component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trialComponentName(String trialComponentName);
/**
*
* A filter that returns only trials created after the specified time.
*
*
* @param createdAfter
* A filter that returns only trials created after the specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdAfter(Instant createdAfter);
/**
*
* A filter that returns only trials created before the specified time.
*
*
* @param createdBefore
* A filter that returns only trials created before the specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdBefore(Instant createdBefore);
/**
*
* The property used to sort results. The default value is CreationTime.
*
*
* @param sortBy
* The property used to sort results. The default value is CreationTime.
* @see SortTrialsBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortTrialsBy
*/
Builder sortBy(String sortBy);
/**
*
* The property used to sort results. The default value is CreationTime.
*
*
* @param sortBy
* The property used to sort results. The default value is CreationTime.
* @see SortTrialsBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortTrialsBy
*/
Builder sortBy(SortTrialsBy sortBy);
/**
*
* The sort order. The default value is Descending.
*
*
* @param sortOrder
* The sort order. The default value is Descending.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sortOrder(String sortOrder);
/**
*
* The sort order. The default value is Descending.
*
*
* @param sortOrder
* The sort order. The default value is Descending.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sortOrder(SortOrder sortOrder);
/**
*
* The maximum number of trials to return in the response. The default value is 10.
*
*
* @param maxResults
* The maximum number of trials to return in the response. The default value is 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String experimentName;
private String trialComponentName;
private Instant createdAfter;
private Instant createdBefore;
private String sortBy;
private String sortOrder;
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListTrialsRequest model) {
super(model);
experimentName(model.experimentName);
trialComponentName(model.trialComponentName);
createdAfter(model.createdAfter);
createdBefore(model.createdBefore);
sortBy(model.sortBy);
sortOrder(model.sortOrder);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final String getExperimentName() {
return experimentName;
}
public final void setExperimentName(String experimentName) {
this.experimentName = experimentName;
}
@Override
public final Builder experimentName(String experimentName) {
this.experimentName = experimentName;
return this;
}
public final String getTrialComponentName() {
return trialComponentName;
}
public final void setTrialComponentName(String trialComponentName) {
this.trialComponentName = trialComponentName;
}
@Override
public final Builder trialComponentName(String trialComponentName) {
this.trialComponentName = trialComponentName;
return this;
}
public final Instant getCreatedAfter() {
return createdAfter;
}
public final void setCreatedAfter(Instant createdAfter) {
this.createdAfter = createdAfter;
}
@Override
public final Builder createdAfter(Instant createdAfter) {
this.createdAfter = createdAfter;
return this;
}
public final Instant getCreatedBefore() {
return createdBefore;
}
public final void setCreatedBefore(Instant createdBefore) {
this.createdBefore = createdBefore;
}
@Override
public final Builder createdBefore(Instant createdBefore) {
this.createdBefore = createdBefore;
return this;
}
public final String getSortBy() {
return sortBy;
}
public final void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
@Override
public final Builder sortBy(String sortBy) {
this.sortBy = sortBy;
return this;
}
@Override
public final Builder sortBy(SortTrialsBy sortBy) {
this.sortBy(sortBy == null ? null : sortBy.toString());
return this;
}
public final String getSortOrder() {
return sortOrder;
}
public final void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
@Override
public final Builder sortOrder(String sortOrder) {
this.sortOrder = sortOrder;
return this;
}
@Override
public final Builder sortOrder(SortOrder sortOrder) {
this.sortOrder(sortOrder == null ? null : sortOrder.toString());
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListTrialsRequest build() {
return new ListTrialsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy