Package software.amazon.awscdk.services.qbusiness

Interface CfnDataAccessor.AttributeFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataAccessor.AttributeFilterProperty.Jsii$Proxy

Enclosing class:

CfnDataAccessor

@Stability(Stable)
public static interface CfnDataAccessor.AttributeFilterProperty
extends software.amazon.jsii.JsiiSerializable

Enables filtering of responses based on document attributes or metadata fields.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qbusiness.*;
 AttributeFilterProperty attributeFilterProperty_;
 AttributeFilterProperty attributeFilterProperty = AttributeFilterProperty.builder()
         .andAllFilters(List.of(attributeFilterProperty_))
         .containsAll(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .containsAny(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .equalsTo(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .greaterThan(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .greaterThanOrEquals(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .lessThan(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .lessThanOrEquals(DocumentAttributeProperty.builder()
                 .name("name")
                 .value(DocumentAttributeValueProperty.builder()
                         .dateValue("dateValue")
                         .longValue(123)
                         .stringListValue(List.of("stringListValue"))
                         .stringValue("stringValue")
                         .build())
                 .build())
         .notFilter(attributeFilterProperty_)
         .orAllFilters(List.of(attributeFilterProperty_))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataAccessor.AttributeFilterProperty.Builder	A builder for CfnDataAccessor.AttributeFilterProperty
static final class	CfnDataAccessor.AttributeFilterProperty.Jsii$Proxy	An implementation for CfnDataAccessor.AttributeFilterProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataAccessor.AttributeFilterProperty.Builder	builder()
default Object	getAndAllFilters()	Performs a logical AND operation on all supplied filters.
default Object	getContainsAll()	Returns true when a document contains all the specified document attributes or metadata fields.
default Object	getContainsAny()	Returns true when a document contains any of the specified document attributes or metadata fields.
default Object	getEqualsTo()	Performs an equals operation on two document attributes or metadata fields.
default Object	getGreaterThan()	Performs a greater than operation on two document attributes or metadata fields.
default Object	getGreaterThanOrEquals()	Performs a greater or equals than operation on two document attributes or metadata fields.
default Object	getLessThan()	Performs a less than operation on two document attributes or metadata fields.
default Object	getLessThanOrEquals()	Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValue and longValue .
default Object	getNotFilter()	Performs a logical NOT operation on all supplied filters.
default Object	getOrAllFilters()	Performs a logical OR operation on all supplied filters.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAndAllFilters

@Stability(Stable)
@Nullable
default Object getAndAllFilters()

Performs a logical AND operation on all supplied filters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-andallfilters

getContainsAll

@Stability(Stable)
@Nullable
default Object getContainsAll()

Returns true when a document contains all the specified document attributes or metadata fields.

Supported for the following document attribute value types : stringListValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsall

getContainsAny

@Stability(Stable)
@Nullable
default Object getContainsAny()

Returns true when a document contains any of the specified document attributes or metadata fields.

Supported for the following document attribute value types : stringListValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsany

getEqualsTo

@Stability(Stable)
@Nullable
default Object getEqualsTo()

Performs an equals operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-equalsto

getGreaterThan

@Stability(Stable)
@Nullable
default Object getGreaterThan()

Performs a greater than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthan

getGreaterThanOrEquals

@Stability(Stable)
@Nullable
default Object getGreaterThanOrEquals()

Performs a greater or equals than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals

getLessThan

@Stability(Stable)
@Nullable
default Object getLessThan()

Performs a less than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthan

getLessThanOrEquals

@Stability(Stable)
@Nullable
default Object getLessThanOrEquals()

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValue and longValue .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals

getNotFilter

@Stability(Stable)
@Nullable
default Object getNotFilter()

Performs a logical NOT operation on all supplied filters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-notfilter

getOrAllFilters

@Stability(Stable)
@Nullable
default Object getOrAllFilters()

Performs a logical OR operation on all supplied filters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-orallfilters

builder

@Stability(Stable)
static CfnDataAccessor.AttributeFilterProperty.Builder builder()

Returns:

a CfnDataAccessor.AttributeFilterProperty.Builder of CfnDataAccessor.AttributeFilterProperty