software.amazon.awssdk.services.sagemaker.model.SearchExpression Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* 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.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A multi-expression that searches for the specified resource or resources in a search. All resource objects that
* satisfy the expression's condition are included in the search results. You must specify at least one subexpression,
* filter, or nested filter. A SearchExpression can contain up to twenty elements.
*
*
* A SearchExpression contains the following components:
*
*
* -
*
* A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource
* property name, Boolean operator, and value.
*
*
* -
*
* A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of
* resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
*
*
* -
*
* A list of SearchExpression objects. A search expression object can be nested in a list of search
* expression objects.
*
*
* -
*
* A Boolean operator: And or Or.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SearchExpression implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(SearchExpression::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> NESTED_FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("NestedFilters")
.getter(getter(SearchExpression::nestedFilters))
.setter(setter(Builder::nestedFilters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NestedFilters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(NestedFilters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SUB_EXPRESSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SubExpressions")
.getter(getter(SearchExpression::subExpressions))
.setter(setter(Builder::subExpressions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubExpressions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SearchExpression::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField OPERATOR_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Operator").getter(getter(SearchExpression::operatorAsString)).setter(setter(Builder::operator))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Operator").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FILTERS_FIELD,
NESTED_FILTERS_FIELD, SUB_EXPRESSIONS_FIELD, OPERATOR_FIELD));
private static final long serialVersionUID = 1L;
private final List filters;
private final List nestedFilters;
private final List subExpressions;
private final String operator;
private SearchExpression(BuilderImpl builder) {
this.filters = builder.filters;
this.nestedFilters = builder.nestedFilters;
this.subExpressions = builder.subExpressions;
this.operator = builder.operator;
}
/**
* For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* A list of filter objects.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasFilters} method.
*
*
* @return A list of filter objects.
*/
public final List filters() {
return filters;
}
/**
* For responses, this returns true if the service returned a value for the NestedFilters property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasNestedFilters() {
return nestedFilters != null && !(nestedFilters instanceof SdkAutoConstructList);
}
/**
*
* A list of nested filter objects.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasNestedFilters} method.
*
*
* @return A list of nested filter objects.
*/
public final List nestedFilters() {
return nestedFilters;
}
/**
* For responses, this returns true if the service returned a value for the SubExpressions property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasSubExpressions() {
return subExpressions != null && !(subExpressions instanceof SdkAutoConstructList);
}
/**
*
* A list of search expression objects.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSubExpressions} method.
*
*
* @return A list of search expression objects.
*/
public final List subExpressions() {
return subExpressions;
}
/**
*
* A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists
* to be satisfied for the entire search expression to be true, specify And. If only a single
* conditional statement needs to be true for the entire search expression to be true, specify Or. The
* default value is And.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #operator} will
* return {@link BooleanOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #operatorAsString}.
*
*
* @return A Boolean operator used to evaluate the search expression. If you want every conditional statement in all
* lists to be satisfied for the entire search expression to be true, specify And. If only a
* single conditional statement needs to be true for the entire search expression to be true, specify
* Or. The default value is And.
* @see BooleanOperator
*/
public final BooleanOperator operator() {
return BooleanOperator.fromValue(operator);
}
/**
*
* A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists
* to be satisfied for the entire search expression to be true, specify And. If only a single
* conditional statement needs to be true for the entire search expression to be true, specify Or. The
* default value is And.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #operator} will
* return {@link BooleanOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #operatorAsString}.
*
*
* @return A Boolean operator used to evaluate the search expression. If you want every conditional statement in all
* lists to be satisfied for the entire search expression to be true, specify And. If only a
* single conditional statement needs to be true for the entire search expression to be true, specify
* Or. The default value is And.
* @see BooleanOperator
*/
public final String operatorAsString() {
return operator;
}
@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 + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasNestedFilters() ? nestedFilters() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSubExpressions() ? subExpressions() : null);
hashCode = 31 * hashCode + Objects.hashCode(operatorAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SearchExpression)) {
return false;
}
SearchExpression other = (SearchExpression) obj;
return hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& hasNestedFilters() == other.hasNestedFilters() && Objects.equals(nestedFilters(), other.nestedFilters())
&& hasSubExpressions() == other.hasSubExpressions() && Objects.equals(subExpressions(), other.subExpressions())
&& Objects.equals(operatorAsString(), other.operatorAsString());
}
/**
* 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("SearchExpression").add("Filters", hasFilters() ? filters() : null)
.add("NestedFilters", hasNestedFilters() ? nestedFilters() : null)
.add("SubExpressions", hasSubExpressions() ? subExpressions() : null).add("Operator", operatorAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "NestedFilters":
return Optional.ofNullable(clazz.cast(nestedFilters()));
case "SubExpressions":
return Optional.ofNullable(clazz.cast(subExpressions()));
case "Operator":
return Optional.ofNullable(clazz.cast(operatorAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchExpression) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of filter objects.
*
*
* @param filters
* A list of filter objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* A list of filter objects.
*
*
* @param filters
* A list of filter objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* A list of filter objects.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(List)
*/
Builder filters(Consumer... filters);
/**
*
* A list of nested filter objects.
*
*
* @param nestedFilters
* A list of nested filter objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nestedFilters(Collection nestedFilters);
/**
*
* A list of nested filter objects.
*
*
* @param nestedFilters
* A list of nested filter objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nestedFilters(NestedFilters... nestedFilters);
/**
*
* A list of nested filter objects.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #nestedFilters(List)}.
*
* @param nestedFilters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #nestedFilters(List)
*/
Builder nestedFilters(Consumer... nestedFilters);
/**
*
* A list of search expression objects.
*
*
* @param subExpressions
* A list of search expression objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subExpressions(Collection subExpressions);
/**
*
* A list of search expression objects.
*
*
* @param subExpressions
* A list of search expression objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subExpressions(SearchExpression... subExpressions);
/**
*
* A list of search expression objects.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #subExpressions(List)}.
*
* @param subExpressions
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #subExpressions(List)
*/
Builder subExpressions(Consumer... subExpressions);
/**
*
* A Boolean operator used to evaluate the search expression. If you want every conditional statement in all
* lists to be satisfied for the entire search expression to be true, specify And. If only a single
* conditional statement needs to be true for the entire search expression to be true, specify Or.
* The default value is And.
*
*
* @param operator
* A Boolean operator used to evaluate the search expression. If you want every conditional statement in
* all lists to be satisfied for the entire search expression to be true, specify And. If
* only a single conditional statement needs to be true for the entire search expression to be true,
* specify Or. The default value is And.
* @see BooleanOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see BooleanOperator
*/
Builder operator(String operator);
/**
*
* A Boolean operator used to evaluate the search expression. If you want every conditional statement in all
* lists to be satisfied for the entire search expression to be true, specify And. If only a single
* conditional statement needs to be true for the entire search expression to be true, specify Or.
* The default value is And.
*
*
* @param operator
* A Boolean operator used to evaluate the search expression. If you want every conditional statement in
* all lists to be satisfied for the entire search expression to be true, specify And. If
* only a single conditional statement needs to be true for the entire search expression to be true,
* specify Or. The default value is And.
* @see BooleanOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see BooleanOperator
*/
Builder operator(BooleanOperator operator);
}
static final class BuilderImpl implements Builder {
private List filters = DefaultSdkAutoConstructList.getInstance();
private List nestedFilters = DefaultSdkAutoConstructList.getInstance();
private List subExpressions = DefaultSdkAutoConstructList.getInstance();
private String operator;
private BuilderImpl() {
}
private BuilderImpl(SearchExpression model) {
filters(model.filters);
nestedFilters(model.nestedFilters);
subExpressions(model.subExpressions);
operator(model.operator);
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
@Transient
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getNestedFilters() {
List result = NestedFiltersListCopier.copyToBuilder(this.nestedFilters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setNestedFilters(Collection nestedFilters) {
this.nestedFilters = NestedFiltersListCopier.copyFromBuilder(nestedFilters);
}
@Override
@Transient
public final Builder nestedFilters(Collection nestedFilters) {
this.nestedFilters = NestedFiltersListCopier.copy(nestedFilters);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder nestedFilters(NestedFilters... nestedFilters) {
nestedFilters(Arrays.asList(nestedFilters));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder nestedFilters(Consumer... nestedFilters) {
nestedFilters(Stream.of(nestedFilters).map(c -> NestedFilters.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getSubExpressions() {
List result = SearchExpressionListCopier.copyToBuilder(this.subExpressions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSubExpressions(Collection subExpressions) {
this.subExpressions = SearchExpressionListCopier.copyFromBuilder(subExpressions);
}
@Override
@Transient
public final Builder subExpressions(Collection subExpressions) {
this.subExpressions = SearchExpressionListCopier.copy(subExpressions);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder subExpressions(SearchExpression... subExpressions) {
subExpressions(Arrays.asList(subExpressions));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder subExpressions(Consumer... subExpressions) {
subExpressions(Stream.of(subExpressions).map(c -> SearchExpression.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getOperator() {
return operator;
}
public final void setOperator(String operator) {
this.operator = operator;
}
@Override
@Transient
public final Builder operator(String operator) {
this.operator = operator;
return this;
}
@Override
@Transient
public final Builder operator(BooleanOperator operator) {
this.operator(operator == null ? null : operator.toString());
return this;
}
@Override
public SearchExpression build() {
return new SearchExpression(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}