software.amazon.awssdk.services.sagemaker.model.ListModelCardsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker Service
/*
* 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.HashMap;
import java.util.List;
import java.util.Map;
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 ListModelCardsRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField CREATION_TIME_AFTER_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTimeAfter").getter(getter(ListModelCardsRequest::creationTimeAfter))
.setter(setter(Builder::creationTimeAfter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTimeAfter").build()).build();
private static final SdkField CREATION_TIME_BEFORE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTimeBefore").getter(getter(ListModelCardsRequest::creationTimeBefore))
.setter(setter(Builder::creationTimeBefore))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTimeBefore").build())
.build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListModelCardsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NAME_CONTAINS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NameContains").getter(getter(ListModelCardsRequest::nameContains)).setter(setter(Builder::nameContains))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NameContains").build()).build();
private static final SdkField MODEL_CARD_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelCardStatus").getter(getter(ListModelCardsRequest::modelCardStatusAsString))
.setter(setter(Builder::modelCardStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelCardStatus").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListModelCardsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField SORT_BY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("SortBy")
.getter(getter(ListModelCardsRequest::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(ListModelCardsRequest::sortOrderAsString)).setter(setter(Builder::sortOrder))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortOrder").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CREATION_TIME_AFTER_FIELD,
CREATION_TIME_BEFORE_FIELD, MAX_RESULTS_FIELD, NAME_CONTAINS_FIELD, MODEL_CARD_STATUS_FIELD, NEXT_TOKEN_FIELD,
SORT_BY_FIELD, SORT_ORDER_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final Instant creationTimeAfter;
private final Instant creationTimeBefore;
private final Integer maxResults;
private final String nameContains;
private final String modelCardStatus;
private final String nextToken;
private final String sortBy;
private final String sortOrder;
private ListModelCardsRequest(BuilderImpl builder) {
super(builder);
this.creationTimeAfter = builder.creationTimeAfter;
this.creationTimeBefore = builder.creationTimeBefore;
this.maxResults = builder.maxResults;
this.nameContains = builder.nameContains;
this.modelCardStatus = builder.modelCardStatus;
this.nextToken = builder.nextToken;
this.sortBy = builder.sortBy;
this.sortOrder = builder.sortOrder;
}
/**
*
* Only list model cards that were created after the time specified.
*
*
* @return Only list model cards that were created after the time specified.
*/
public final Instant creationTimeAfter() {
return creationTimeAfter;
}
/**
*
* Only list model cards that were created before the time specified.
*
*
* @return Only list model cards that were created before the time specified.
*/
public final Instant creationTimeBefore() {
return creationTimeBefore;
}
/**
*
* The maximum number of model cards to list.
*
*
* @return The maximum number of model cards to list.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* Only list model cards with names that contain the specified string.
*
*
* @return Only list model cards with names that contain the specified string.
*/
public final String nameContains() {
return nameContains;
}
/**
*
* Only list model cards with the specified approval status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #modelCardStatus}
* will return {@link ModelCardStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #modelCardStatusAsString}.
*
*
* @return Only list model cards with the specified approval status.
* @see ModelCardStatus
*/
public final ModelCardStatus modelCardStatus() {
return ModelCardStatus.fromValue(modelCardStatus);
}
/**
*
* Only list model cards with the specified approval status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #modelCardStatus}
* will return {@link ModelCardStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #modelCardStatusAsString}.
*
*
* @return Only list model cards with the specified approval status.
* @see ModelCardStatus
*/
public final String modelCardStatusAsString() {
return modelCardStatus;
}
/**
*
* If the response to a previous ListModelCards request was truncated, the response includes a
* NextToken. To retrieve the next set of model cards, use the token in the next request.
*
*
* @return If the response to a previous ListModelCards request was truncated, the response includes a
* NextToken. To retrieve the next set of model cards, use the token in the next request.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* Sort model cards by either name or creation time. Sorts by creation time by default.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link ModelCardSortBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortByAsString}.
*
*
* @return Sort model cards by either name or creation time. Sorts by creation time by default.
* @see ModelCardSortBy
*/
public final ModelCardSortBy sortBy() {
return ModelCardSortBy.fromValue(sortBy);
}
/**
*
* Sort model cards by either name or creation time. Sorts by creation time by default.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link ModelCardSortBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortByAsString}.
*
*
* @return Sort model cards by either name or creation time. Sorts by creation time by default.
* @see ModelCardSortBy
*/
public final String sortByAsString() {
return sortBy;
}
/**
*
* Sort model cards by ascending or descending order.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link ModelCardSortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return Sort model cards by ascending or descending order.
* @see ModelCardSortOrder
*/
public final ModelCardSortOrder sortOrder() {
return ModelCardSortOrder.fromValue(sortOrder);
}
/**
*
* Sort model cards by ascending or descending order.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link ModelCardSortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return Sort model cards by ascending or descending order.
* @see ModelCardSortOrder
*/
public final String sortOrderAsString() {
return sortOrder;
}
@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(creationTimeAfter());
hashCode = 31 * hashCode + Objects.hashCode(creationTimeBefore());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nameContains());
hashCode = 31 * hashCode + Objects.hashCode(modelCardStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(sortByAsString());
hashCode = 31 * hashCode + Objects.hashCode(sortOrderAsString());
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 ListModelCardsRequest)) {
return false;
}
ListModelCardsRequest other = (ListModelCardsRequest) obj;
return Objects.equals(creationTimeAfter(), other.creationTimeAfter())
&& Objects.equals(creationTimeBefore(), other.creationTimeBefore())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nameContains(), other.nameContains())
&& Objects.equals(modelCardStatusAsString(), other.modelCardStatusAsString())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(sortByAsString(), other.sortByAsString())
&& Objects.equals(sortOrderAsString(), other.sortOrderAsString());
}
/**
* 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("ListModelCardsRequest").add("CreationTimeAfter", creationTimeAfter())
.add("CreationTimeBefore", creationTimeBefore()).add("MaxResults", maxResults())
.add("NameContains", nameContains()).add("ModelCardStatus", modelCardStatusAsString())
.add("NextToken", nextToken()).add("SortBy", sortByAsString()).add("SortOrder", sortOrderAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CreationTimeAfter":
return Optional.ofNullable(clazz.cast(creationTimeAfter()));
case "CreationTimeBefore":
return Optional.ofNullable(clazz.cast(creationTimeBefore()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NameContains":
return Optional.ofNullable(clazz.cast(nameContains()));
case "ModelCardStatus":
return Optional.ofNullable(clazz.cast(modelCardStatusAsString()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "SortBy":
return Optional.ofNullable(clazz.cast(sortByAsString()));
case "SortOrder":
return Optional.ofNullable(clazz.cast(sortOrderAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("CreationTimeAfter", CREATION_TIME_AFTER_FIELD);
map.put("CreationTimeBefore", CREATION_TIME_BEFORE_FIELD);
map.put("MaxResults", MAX_RESULTS_FIELD);
map.put("NameContains", NAME_CONTAINS_FIELD);
map.put("ModelCardStatus", MODEL_CARD_STATUS_FIELD);
map.put("NextToken", NEXT_TOKEN_FIELD);
map.put("SortBy", SORT_BY_FIELD);
map.put("SortOrder", SORT_ORDER_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListModelCardsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Only list model cards that were created after the time specified.
*
*
* @param creationTimeAfter
* Only list model cards that were created after the time specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimeAfter(Instant creationTimeAfter);
/**
*
* Only list model cards that were created before the time specified.
*
*
* @param creationTimeBefore
* Only list model cards that were created before the time specified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimeBefore(Instant creationTimeBefore);
/**
*
* The maximum number of model cards to list.
*
*
* @param maxResults
* The maximum number of model cards to list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Only list model cards with names that contain the specified string.
*
*
* @param nameContains
* Only list model cards with names that contain the specified string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nameContains(String nameContains);
/**
*
* Only list model cards with the specified approval status.
*
*
* @param modelCardStatus
* Only list model cards with the specified approval status.
* @see ModelCardStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardStatus
*/
Builder modelCardStatus(String modelCardStatus);
/**
*
* Only list model cards with the specified approval status.
*
*
* @param modelCardStatus
* Only list model cards with the specified approval status.
* @see ModelCardStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardStatus
*/
Builder modelCardStatus(ModelCardStatus modelCardStatus);
/**
*
* If the response to a previous ListModelCards request was truncated, the response includes a
* NextToken. To retrieve the next set of model cards, use the token in the next request.
*
*
* @param nextToken
* If the response to a previous ListModelCards request was truncated, the response includes
* a NextToken. To retrieve the next set of model cards, use the token in the next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Sort model cards by either name or creation time. Sorts by creation time by default.
*
*
* @param sortBy
* Sort model cards by either name or creation time. Sorts by creation time by default.
* @see ModelCardSortBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardSortBy
*/
Builder sortBy(String sortBy);
/**
*
* Sort model cards by either name or creation time. Sorts by creation time by default.
*
*
* @param sortBy
* Sort model cards by either name or creation time. Sorts by creation time by default.
* @see ModelCardSortBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardSortBy
*/
Builder sortBy(ModelCardSortBy sortBy);
/**
*
* Sort model cards by ascending or descending order.
*
*
* @param sortOrder
* Sort model cards by ascending or descending order.
* @see ModelCardSortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardSortOrder
*/
Builder sortOrder(String sortOrder);
/**
*
* Sort model cards by ascending or descending order.
*
*
* @param sortOrder
* Sort model cards by ascending or descending order.
* @see ModelCardSortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see ModelCardSortOrder
*/
Builder sortOrder(ModelCardSortOrder sortOrder);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private Instant creationTimeAfter;
private Instant creationTimeBefore;
private Integer maxResults;
private String nameContains;
private String modelCardStatus;
private String nextToken;
private String sortBy;
private String sortOrder;
private BuilderImpl() {
}
private BuilderImpl(ListModelCardsRequest model) {
super(model);
creationTimeAfter(model.creationTimeAfter);
creationTimeBefore(model.creationTimeBefore);
maxResults(model.maxResults);
nameContains(model.nameContains);
modelCardStatus(model.modelCardStatus);
nextToken(model.nextToken);
sortBy(model.sortBy);
sortOrder(model.sortOrder);
}
public final Instant getCreationTimeAfter() {
return creationTimeAfter;
}
public final void setCreationTimeAfter(Instant creationTimeAfter) {
this.creationTimeAfter = creationTimeAfter;
}
@Override
public final Builder creationTimeAfter(Instant creationTimeAfter) {
this.creationTimeAfter = creationTimeAfter;
return this;
}
public final Instant getCreationTimeBefore() {
return creationTimeBefore;
}
public final void setCreationTimeBefore(Instant creationTimeBefore) {
this.creationTimeBefore = creationTimeBefore;
}
@Override
public final Builder creationTimeBefore(Instant creationTimeBefore) {
this.creationTimeBefore = creationTimeBefore;
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 getNameContains() {
return nameContains;
}
public final void setNameContains(String nameContains) {
this.nameContains = nameContains;
}
@Override
public final Builder nameContains(String nameContains) {
this.nameContains = nameContains;
return this;
}
public final String getModelCardStatus() {
return modelCardStatus;
}
public final void setModelCardStatus(String modelCardStatus) {
this.modelCardStatus = modelCardStatus;
}
@Override
public final Builder modelCardStatus(String modelCardStatus) {
this.modelCardStatus = modelCardStatus;
return this;
}
@Override
public final Builder modelCardStatus(ModelCardStatus modelCardStatus) {
this.modelCardStatus(modelCardStatus == null ? null : modelCardStatus.toString());
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;
}
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(ModelCardSortBy 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(ModelCardSortOrder sortOrder) {
this.sortOrder(sortOrder == null ? null : sortOrder.toString());
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 ListModelCardsRequest build() {
return new ListModelCardsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy