com.amazonaws.services.connect.model

Class UserSearchFilter

java.lang.Object

com.amazonaws.services.connect.model.UserSearchFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserSearchFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

Filters to be applied to search results.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserSearchFilter()

Method Summary

Modifier and Type	Method and Description
UserSearchFilter	clone()
boolean	equals(Object obj)
ControlPlaneTagFilter	getTagFilter()
ControlPlaneUserAttributeFilter	getUserAttributeFilter() An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setTagFilter(ControlPlaneTagFilter tagFilter)
void	setUserAttributeFilter(ControlPlaneUserAttributeFilter userAttributeFilter) An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.
String	toString() Returns a string representation of this object.
UserSearchFilter	withTagFilter(ControlPlaneTagFilter tagFilter)
UserSearchFilter	withUserAttributeFilter(ControlPlaneUserAttributeFilter userAttributeFilter) An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserSearchFilter

public UserSearchFilter()

Method Detail

setTagFilter

public void setTagFilter(ControlPlaneTagFilter tagFilter)

Parameters:

tagFilter -

getTagFilter

public ControlPlaneTagFilter getTagFilter()

Returns:

withTagFilter

public UserSearchFilter withTagFilter(ControlPlaneTagFilter tagFilter)

Parameters:

tagFilter -

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserAttributeFilter

public void setUserAttributeFilter(ControlPlaneUserAttributeFilter userAttributeFilter)

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

Parameters:

userAttributeFilter - An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

getUserAttributeFilter

public ControlPlaneUserAttributeFilter getUserAttributeFilter()

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

Returns:

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

withUserAttributeFilter

public UserSearchFilter withUserAttributeFilter(ControlPlaneUserAttributeFilter userAttributeFilter)

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

Parameters:

userAttributeFilter - An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.

• The inner list specifies conditions that need to be applied with AND operator.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UserSearchFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.