com.amazonaws.services.qbusiness.model

Class DocumentAttributeConfiguration

java.lang.Object

com.amazonaws.services.qbusiness.model.DocumentAttributeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentAttributeConfiguration()

Method Summary

Modifier and Type	Method and Description
DocumentAttributeConfiguration	clone()
boolean	equals(Object obj)
String	getName() The name of the document attribute.
String	getSearch() Information about whether the document attribute can be used by an end user to search for information on their web experience.
String	getType() The type of document attribute.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setName(String name) The name of the document attribute.
void	setSearch(String search) Information about whether the document attribute can be used by an end user to search for information on their web experience.
void	setType(String type) The type of document attribute.
String	toString() Returns a string representation of this object.
DocumentAttributeConfiguration	withName(String name) The name of the document attribute.
DocumentAttributeConfiguration	withSearch(Status search) Information about whether the document attribute can be used by an end user to search for information on their web experience.
DocumentAttributeConfiguration	withSearch(String search) Information about whether the document attribute can be used by an end user to search for information on their web experience.
DocumentAttributeConfiguration	withType(AttributeType type) The type of document attribute.
DocumentAttributeConfiguration	withType(String type) The type of document attribute.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentAttributeConfiguration

public DocumentAttributeConfiguration()

Method Detail

setName

public void setName(String name)

The name of the document attribute.

Parameters:

name - The name of the document attribute.

getName

public String getName()

The name of the document attribute.

Returns:

The name of the document attribute.

withName

public DocumentAttributeConfiguration withName(String name)

The name of the document attribute.

Parameters:

name - The name of the document attribute.

Returns:

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

setSearch

public void setSearch(String search)

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Parameters:

search - Information about whether the document attribute can be used by an end user to search for information on their web experience.

See Also:

Status

getSearch

public String getSearch()

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Returns:

Information about whether the document attribute can be used by an end user to search for information on their web experience.

See Also:

Status

withSearch

public DocumentAttributeConfiguration withSearch(String search)

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Parameters:

search - Information about whether the document attribute can be used by an end user to search for information on their web experience.

Returns:

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

See Also:

Status

withSearch

public DocumentAttributeConfiguration withSearch(Status search)

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Parameters:

search - Information about whether the document attribute can be used by an end user to search for information on their web experience.

Returns:

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

See Also:

Status

setType

public void setType(String type)

The type of document attribute.

Parameters:

type - The type of document attribute.

See Also:

AttributeType

getType

public String getType()

The type of document attribute.

Returns:

The type of document attribute.

See Also:

AttributeType

withType

public DocumentAttributeConfiguration withType(String type)

The type of document attribute.

Parameters:

type - The type of document attribute.

Returns:

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

See Also:

AttributeType

withType

public DocumentAttributeConfiguration withType(AttributeType type)

The type of document attribute.

Parameters:

type - The type of document attribute.

Returns:

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

See Also:

AttributeType

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 DocumentAttributeConfiguration 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.