software.amazon.awssdk.services.sagemaker.model.ListImageVersionsRequest 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.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 ListImageVersionsRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField CREATION_TIME_AFTER_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTimeAfter").getter(getter(ListImageVersionsRequest::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(ListImageVersionsRequest::creationTimeBefore))
.setter(setter(Builder::creationTimeBefore))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTimeBefore").build())
.build();
private static final SdkField IMAGE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ImageName").getter(getter(ListImageVersionsRequest::imageName)).setter(setter(Builder::imageName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ImageName").build()).build();
private static final SdkField LAST_MODIFIED_TIME_AFTER_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTimeAfter").getter(getter(ListImageVersionsRequest::lastModifiedTimeAfter))
.setter(setter(Builder::lastModifiedTimeAfter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTimeAfter").build())
.build();
private static final SdkField LAST_MODIFIED_TIME_BEFORE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTimeBefore").getter(getter(ListImageVersionsRequest::lastModifiedTimeBefore))
.setter(setter(Builder::lastModifiedTimeBefore))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTimeBefore").build())
.build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListImageVersionsRequest::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(ListImageVersionsRequest::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(ListImageVersionsRequest::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(ListImageVersionsRequest::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, IMAGE_NAME_FIELD, LAST_MODIFIED_TIME_AFTER_FIELD, LAST_MODIFIED_TIME_BEFORE_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, SORT_BY_FIELD, SORT_ORDER_FIELD));
private final Instant creationTimeAfter;
private final Instant creationTimeBefore;
private final String imageName;
private final Instant lastModifiedTimeAfter;
private final Instant lastModifiedTimeBefore;
private final Integer maxResults;
private final String nextToken;
private final String sortBy;
private final String sortOrder;
private ListImageVersionsRequest(BuilderImpl builder) {
super(builder);
this.creationTimeAfter = builder.creationTimeAfter;
this.creationTimeBefore = builder.creationTimeBefore;
this.imageName = builder.imageName;
this.lastModifiedTimeAfter = builder.lastModifiedTimeAfter;
this.lastModifiedTimeBefore = builder.lastModifiedTimeBefore;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.sortBy = builder.sortBy;
this.sortOrder = builder.sortOrder;
}
/**
*
* A filter that returns only versions created on or after the specified time.
*
*
* @return A filter that returns only versions created on or after the specified time.
*/
public final Instant creationTimeAfter() {
return creationTimeAfter;
}
/**
*
* A filter that returns only versions created on or before the specified time.
*
*
* @return A filter that returns only versions created on or before the specified time.
*/
public final Instant creationTimeBefore() {
return creationTimeBefore;
}
/**
*
* The name of the image to list the versions of.
*
*
* @return The name of the image to list the versions of.
*/
public final String imageName() {
return imageName;
}
/**
*
* A filter that returns only versions modified on or after the specified time.
*
*
* @return A filter that returns only versions modified on or after the specified time.
*/
public final Instant lastModifiedTimeAfter() {
return lastModifiedTimeAfter;
}
/**
*
* A filter that returns only versions modified on or before the specified time.
*
*
* @return A filter that returns only versions modified on or before the specified time.
*/
public final Instant lastModifiedTimeBefore() {
return lastModifiedTimeBefore;
}
/**
*
* The maximum number of versions to return in the response. The default value is 10.
*
*
* @return The maximum number of versions to return in the response. The default value is 10.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* If the previous call to ListImageVersions didn't return the full set of versions, the call returns a
* token for getting the next set of versions.
*
*
* @return If the previous call to ListImageVersions didn't return the full set of versions, the call
* returns a token for getting the next set of versions.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The property used to sort results. The default value is CREATION_TIME.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link ImageVersionSortBy#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 CREATION_TIME.
* @see ImageVersionSortBy
*/
public final ImageVersionSortBy sortBy() {
return ImageVersionSortBy.fromValue(sortBy);
}
/**
*
* The property used to sort results. The default value is CREATION_TIME.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link ImageVersionSortBy#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 CREATION_TIME.
* @see ImageVersionSortBy
*/
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 ImageVersionSortOrder#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 ImageVersionSortOrder
*/
public final ImageVersionSortOrder sortOrder() {
return ImageVersionSortOrder.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 ImageVersionSortOrder#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 ImageVersionSortOrder
*/
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(imageName());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTimeAfter());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTimeBefore());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 ListImageVersionsRequest)) {
return false;
}
ListImageVersionsRequest other = (ListImageVersionsRequest) obj;
return Objects.equals(creationTimeAfter(), other.creationTimeAfter())
&& Objects.equals(creationTimeBefore(), other.creationTimeBefore())
&& Objects.equals(imageName(), other.imageName())
&& Objects.equals(lastModifiedTimeAfter(), other.lastModifiedTimeAfter())
&& Objects.equals(lastModifiedTimeBefore(), other.lastModifiedTimeBefore())
&& Objects.equals(maxResults(), other.maxResults()) && 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("ListImageVersionsRequest").add("CreationTimeAfter", creationTimeAfter())
.add("CreationTimeBefore", creationTimeBefore()).add("ImageName", imageName())
.add("LastModifiedTimeAfter", lastModifiedTimeAfter()).add("LastModifiedTimeBefore", lastModifiedTimeBefore())
.add("MaxResults", maxResults()).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 "ImageName":
return Optional.ofNullable(clazz.cast(imageName()));
case "LastModifiedTimeAfter":
return Optional.ofNullable(clazz.cast(lastModifiedTimeAfter()));
case "LastModifiedTimeBefore":
return Optional.ofNullable(clazz.cast(lastModifiedTimeBefore()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
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;
}
private static Function getter(Function g) {
return obj -> g.apply((ListImageVersionsRequest) 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 versions created on or after the specified time.
*
*
* @param creationTimeAfter
* A filter that returns only versions created on or after the specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimeAfter(Instant creationTimeAfter);
/**
*
* A filter that returns only versions created on or before the specified time.
*
*
* @param creationTimeBefore
* A filter that returns only versions created on or before the specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimeBefore(Instant creationTimeBefore);
/**
*
* The name of the image to list the versions of.
*
*
* @param imageName
* The name of the image to list the versions of.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageName(String imageName);
/**
*
* A filter that returns only versions modified on or after the specified time.
*
*
* @param lastModifiedTimeAfter
* A filter that returns only versions modified on or after the specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTimeAfter(Instant lastModifiedTimeAfter);
/**
*
* A filter that returns only versions modified on or before the specified time.
*
*
* @param lastModifiedTimeBefore
* A filter that returns only versions modified on or before the specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTimeBefore(Instant lastModifiedTimeBefore);
/**
*
* The maximum number of versions to return in the response. The default value is 10.
*
*
* @param maxResults
* The maximum number of versions 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 ListImageVersions didn't return the full set of versions, the call
* returns a token for getting the next set of versions.
*
*
* @param nextToken
* If the previous call to ListImageVersions didn't return the full set of versions, the
* call returns a token for getting the next set of versions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The property used to sort results. The default value is CREATION_TIME.
*
*
* @param sortBy
* The property used to sort results. The default value is CREATION_TIME.
* @see ImageVersionSortBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImageVersionSortBy
*/
Builder sortBy(String sortBy);
/**
*
* The property used to sort results. The default value is CREATION_TIME.
*
*
* @param sortBy
* The property used to sort results. The default value is CREATION_TIME.
* @see ImageVersionSortBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImageVersionSortBy
*/
Builder sortBy(ImageVersionSortBy sortBy);
/**
*
* The sort order. The default value is DESCENDING.
*
*
* @param sortOrder
* The sort order. The default value is DESCENDING.
* @see ImageVersionSortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImageVersionSortOrder
*/
Builder sortOrder(String sortOrder);
/**
*
* The sort order. The default value is DESCENDING.
*
*
* @param sortOrder
* The sort order. The default value is DESCENDING.
* @see ImageVersionSortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImageVersionSortOrder
*/
Builder sortOrder(ImageVersionSortOrder 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 String imageName;
private Instant lastModifiedTimeAfter;
private Instant lastModifiedTimeBefore;
private Integer maxResults;
private String nextToken;
private String sortBy;
private String sortOrder;
private BuilderImpl() {
}
private BuilderImpl(ListImageVersionsRequest model) {
super(model);
creationTimeAfter(model.creationTimeAfter);
creationTimeBefore(model.creationTimeBefore);
imageName(model.imageName);
lastModifiedTimeAfter(model.lastModifiedTimeAfter);
lastModifiedTimeBefore(model.lastModifiedTimeBefore);
maxResults(model.maxResults);
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 String getImageName() {
return imageName;
}
public final void setImageName(String imageName) {
this.imageName = imageName;
}
@Override
public final Builder imageName(String imageName) {
this.imageName = imageName;
return this;
}
public final Instant getLastModifiedTimeAfter() {
return lastModifiedTimeAfter;
}
public final void setLastModifiedTimeAfter(Instant lastModifiedTimeAfter) {
this.lastModifiedTimeAfter = lastModifiedTimeAfter;
}
@Override
public final Builder lastModifiedTimeAfter(Instant lastModifiedTimeAfter) {
this.lastModifiedTimeAfter = lastModifiedTimeAfter;
return this;
}
public final Instant getLastModifiedTimeBefore() {
return lastModifiedTimeBefore;
}
public final void setLastModifiedTimeBefore(Instant lastModifiedTimeBefore) {
this.lastModifiedTimeBefore = lastModifiedTimeBefore;
}
@Override
public final Builder lastModifiedTimeBefore(Instant lastModifiedTimeBefore) {
this.lastModifiedTimeBefore = lastModifiedTimeBefore;
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;
}
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(ImageVersionSortBy 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(ImageVersionSortOrder 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 ListImageVersionsRequest build() {
return new ListImageVersionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy