software.amazon.awssdk.services.sagemaker.model.SearchRequest 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.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 SearchRequest extends SageMakerRequest implements ToCopyableBuilder {
private static final SdkField RESOURCE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Resource").getter(getter(SearchRequest::resourceAsString)).setter(setter(Builder::resource))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Resource").build()).build();
private static final SdkField SEARCH_EXPRESSION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SearchExpression")
.getter(getter(SearchRequest::searchExpression)).setter(setter(Builder::searchExpression))
.constructor(SearchExpression::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SearchExpression").build()).build();
private static final SdkField SORT_BY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("SortBy")
.getter(getter(SearchRequest::sortBy)).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(SearchRequest::sortOrderAsString)).setter(setter(Builder::sortOrder))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortOrder").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(SearchRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(SearchRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESOURCE_FIELD,
SEARCH_EXPRESSION_FIELD, SORT_BY_FIELD, SORT_ORDER_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String resource;
private final SearchExpression searchExpression;
private final String sortBy;
private final String sortOrder;
private final String nextToken;
private final Integer maxResults;
private SearchRequest(BuilderImpl builder) {
super(builder);
this.resource = builder.resource;
this.searchExpression = builder.searchExpression;
this.sortBy = builder.sortBy;
this.sortOrder = builder.sortOrder;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The name of the Amazon SageMaker resource to search for.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resource} will
* return {@link ResourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #resourceAsString}.
*
*
* @return The name of the Amazon SageMaker resource to search for.
* @see ResourceType
*/
public final ResourceType resource() {
return ResourceType.fromValue(resource);
}
/**
*
* The name of the Amazon SageMaker resource to search for.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #resource} will
* return {@link ResourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #resourceAsString}.
*
*
* @return The name of the Amazon SageMaker resource to search for.
* @see ResourceType
*/
public final String resourceAsString() {
return resource;
}
/**
*
* A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must
* provide at least one subexpression, filter, or nested filter. The maximum number of recursive
* SubExpressions, NestedFilters, and Filters that can be included in a
* SearchExpression object is 50.
*
*
* @return A Boolean conditional statement. Resources must satisfy this condition to be included in search results.
* You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive
* SubExpressions, NestedFilters, and Filters that can be included in
* a SearchExpression object is 50.
*/
public final SearchExpression searchExpression() {
return searchExpression;
}
/**
*
* The name of the resource property used to sort the SearchResults. The default is
* LastModifiedTime.
*
*
* @return The name of the resource property used to sort the SearchResults. The default is
* LastModifiedTime.
*/
public final String sortBy() {
return sortBy;
}
/**
*
* How SearchResults are ordered. Valid values are Ascending or Descending.
* The default is Descending.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link SearchSortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return How SearchResults are ordered. Valid values are Ascending or
* Descending. The default is Descending.
* @see SearchSortOrder
*/
public final SearchSortOrder sortOrder() {
return SearchSortOrder.fromValue(sortOrder);
}
/**
*
* How SearchResults are ordered. Valid values are Ascending or Descending.
* The default is Descending.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link SearchSortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return How SearchResults are ordered. Valid values are Ascending or
* Descending. The default is Descending.
* @see SearchSortOrder
*/
public final String sortOrderAsString() {
return sortOrder;
}
/**
*
* If more than MaxResults resources match the specified SearchExpression, the response
* includes a NextToken. The NextToken can be passed to the next
* SearchRequest to continue retrieving results.
*
*
* @return If more than MaxResults resources match the specified SearchExpression, the
* response includes a NextToken. The NextToken can be passed to the next
* SearchRequest to continue retrieving results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to return.
*
*
* @return The maximum number of results to return.
*/
public final Integer maxResults() {
return maxResults;
}
@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(resourceAsString());
hashCode = 31 * hashCode + Objects.hashCode(searchExpression());
hashCode = 31 * hashCode + Objects.hashCode(sortBy());
hashCode = 31 * hashCode + Objects.hashCode(sortOrderAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 SearchRequest)) {
return false;
}
SearchRequest other = (SearchRequest) obj;
return Objects.equals(resourceAsString(), other.resourceAsString())
&& Objects.equals(searchExpression(), other.searchExpression()) && Objects.equals(sortBy(), other.sortBy())
&& Objects.equals(sortOrderAsString(), other.sortOrderAsString())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("SearchRequest").add("Resource", resourceAsString()).add("SearchExpression", searchExpression())
.add("SortBy", sortBy()).add("SortOrder", sortOrderAsString()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Resource":
return Optional.ofNullable(clazz.cast(resourceAsString()));
case "SearchExpression":
return Optional.ofNullable(clazz.cast(searchExpression()));
case "SortBy":
return Optional.ofNullable(clazz.cast(sortBy()));
case "SortOrder":
return Optional.ofNullable(clazz.cast(sortOrderAsString()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the Amazon SageMaker resource to search for.
*
*
* @param resource
* The name of the Amazon SageMaker resource to search for.
* @see ResourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
Builder resource(String resource);
/**
*
* The name of the Amazon SageMaker resource to search for.
*
*
* @param resource
* The name of the Amazon SageMaker resource to search for.
* @see ResourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
Builder resource(ResourceType resource);
/**
*
* A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You
* must provide at least one subexpression, filter, or nested filter. The maximum number of recursive
* SubExpressions, NestedFilters, and Filters that can be included in a
* SearchExpression object is 50.
*
*
* @param searchExpression
* A Boolean conditional statement. Resources must satisfy this condition to be included in search
* results. You must provide at least one subexpression, filter, or nested filter. The maximum number of
* recursive SubExpressions, NestedFilters, and Filters that can
* be included in a SearchExpression object is 50.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchExpression(SearchExpression searchExpression);
/**
*
* A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You
* must provide at least one subexpression, filter, or nested filter. The maximum number of recursive
* SubExpressions, NestedFilters, and Filters that can be included in a
* SearchExpression object is 50.
*
* This is a convenience that creates an instance of the {@link SearchExpression.Builder} avoiding the need to
* create one manually via {@link SearchExpression#builder()}.
*
* When the {@link Consumer} completes, {@link SearchExpression.Builder#build()} is called immediately and its
* result is passed to {@link #searchExpression(SearchExpression)}.
*
* @param searchExpression
* a consumer that will call methods on {@link SearchExpression.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #searchExpression(SearchExpression)
*/
default Builder searchExpression(Consumer searchExpression) {
return searchExpression(SearchExpression.builder().applyMutation(searchExpression).build());
}
/**
*
* The name of the resource property used to sort the SearchResults. The default is
* LastModifiedTime.
*
*
* @param sortBy
* The name of the resource property used to sort the SearchResults. The default is
* LastModifiedTime.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sortBy(String sortBy);
/**
*
* How SearchResults are ordered. Valid values are Ascending or
* Descending. The default is Descending.
*
*
* @param sortOrder
* How SearchResults are ordered. Valid values are Ascending or
* Descending. The default is Descending.
* @see SearchSortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SearchSortOrder
*/
Builder sortOrder(String sortOrder);
/**
*
* How SearchResults are ordered. Valid values are Ascending or
* Descending. The default is Descending.
*
*
* @param sortOrder
* How SearchResults are ordered. Valid values are Ascending or
* Descending. The default is Descending.
* @see SearchSortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SearchSortOrder
*/
Builder sortOrder(SearchSortOrder sortOrder);
/**
*
* If more than MaxResults resources match the specified SearchExpression, the
* response includes a NextToken. The NextToken can be passed to the next
* SearchRequest to continue retrieving results.
*
*
* @param nextToken
* If more than MaxResults resources match the specified SearchExpression, the
* response includes a NextToken. The NextToken can be passed to the next
* SearchRequest to continue retrieving results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of results to return.
*
*
* @param maxResults
* The maximum number of results to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String resource;
private SearchExpression searchExpression;
private String sortBy;
private String sortOrder;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(SearchRequest model) {
super(model);
resource(model.resource);
searchExpression(model.searchExpression);
sortBy(model.sortBy);
sortOrder(model.sortOrder);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getResource() {
return resource;
}
@Override
public final Builder resource(String resource) {
this.resource = resource;
return this;
}
@Override
public final Builder resource(ResourceType resource) {
this.resource(resource == null ? null : resource.toString());
return this;
}
public final void setResource(String resource) {
this.resource = resource;
}
public final SearchExpression.Builder getSearchExpression() {
return searchExpression != null ? searchExpression.toBuilder() : null;
}
@Override
public final Builder searchExpression(SearchExpression searchExpression) {
this.searchExpression = searchExpression;
return this;
}
public final void setSearchExpression(SearchExpression.BuilderImpl searchExpression) {
this.searchExpression = searchExpression != null ? searchExpression.build() : null;
}
public final String getSortBy() {
return sortBy;
}
@Override
public final Builder sortBy(String sortBy) {
this.sortBy = sortBy;
return this;
}
public final void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
public final String getSortOrder() {
return sortOrder;
}
@Override
public final Builder sortOrder(String sortOrder) {
this.sortOrder = sortOrder;
return this;
}
@Override
public final Builder sortOrder(SearchSortOrder sortOrder) {
this.sortOrder(sortOrder == null ? null : sortOrder.toString());
return this;
}
public final void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SearchRequest build() {
return new SearchRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}