NamedEntityDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.NamedEntityDefinition

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

A structure that represents a named entity.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NamedEntityDefinition()

Constructors
Constructor and Description
`NamedEntityDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NamedEntityDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFieldName()` The name of the entity.
`NamedEntityDefinitionMetric`	`getMetric()` The definition of a metric.
`String`	`getPropertyName()` The property name to be used for the named entity.
`String`	`getPropertyRole()` The property role.
`String`	`getPropertyUsage()` The property usage.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFieldName(String fieldName)` The name of the entity.
`void`	`setMetric(NamedEntityDefinitionMetric metric)` The definition of a metric.
`void`	`setPropertyName(String propertyName)` The property name to be used for the named entity.
`void`	`setPropertyRole(String propertyRole)` The property role.
`void`	`setPropertyUsage(String propertyUsage)` The property usage.
`String`	`toString()` Returns a string representation of this object.
`NamedEntityDefinition`	`withFieldName(String fieldName)` The name of the entity.
`NamedEntityDefinition`	`withMetric(NamedEntityDefinitionMetric metric)` The definition of a metric.
`NamedEntityDefinition`	`withPropertyName(String propertyName)` The property name to be used for the named entity.
`NamedEntityDefinition`	`withPropertyRole(PropertyRole propertyRole)` The property role.
`NamedEntityDefinition`	`withPropertyRole(String propertyRole)` The property role.
`NamedEntityDefinition`	`withPropertyUsage(PropertyUsage propertyUsage)` The property usage.
`NamedEntityDefinition`	`withPropertyUsage(String propertyUsage)` The property usage.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NamedEntityDefinition
```
public NamedEntityDefinition()
```
- Method Detail
  - setFieldName
```
public void setFieldName(String fieldName)
```
    The name of the entity.
    
    Parameters:
    
    fieldName - The name of the entity.
  - getFieldName
```
public String getFieldName()
```
    The name of the entity.
    
    Returns:
    
    The name of the entity.
  - withFieldName
```
public NamedEntityDefinition withFieldName(String fieldName)
```
    The name of the entity.
    
    Parameters:
    
    fieldName - The name of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropertyName
```
public void setPropertyName(String propertyName)
```
    The property name to be used for the named entity.
    
    Parameters:
    
    propertyName - The property name to be used for the named entity.
  - getPropertyName
```
public String getPropertyName()
```
    The property name to be used for the named entity.
    
    Returns:
    
    The property name to be used for the named entity.
  - withPropertyName
```
public NamedEntityDefinition withPropertyName(String propertyName)
```
    The property name to be used for the named entity.
    
    Parameters:
    
    propertyName - The property name to be used for the named entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropertyRole
```
public void setPropertyRole(String propertyRole)
```
    The property role. Valid values for this structure are PRIMARY and ID.
    
    Parameters:
    
    propertyRole - The property role. Valid values for this structure are PRIMARY and ID.
    
    See Also:
    
    PropertyRole
  - getPropertyRole
```
public String getPropertyRole()
```
    The property role. Valid values for this structure are PRIMARY and ID.
    
    Returns:
    
    The property role. Valid values for this structure are PRIMARY and ID.
    
    See Also:
    
    PropertyRole
  - withPropertyRole
```
public NamedEntityDefinition withPropertyRole(String propertyRole)
```
    The property role. Valid values for this structure are PRIMARY and ID.
    
    Parameters:
    
    propertyRole - The property role. Valid values for this structure are PRIMARY and ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyRole
  - withPropertyRole
```
public NamedEntityDefinition withPropertyRole(PropertyRole propertyRole)
```
    The property role. Valid values for this structure are PRIMARY and ID.
    
    Parameters:
    
    propertyRole - The property role. Valid values for this structure are PRIMARY and ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyRole
  - setPropertyUsage
```
public void setPropertyUsage(String propertyUsage)
```
    The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    Parameters:
    
    propertyUsage - The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    See Also:
    
    PropertyUsage
  - getPropertyUsage
```
public String getPropertyUsage()
```
    The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    Returns:
    
    The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    See Also:
    
    PropertyUsage
  - withPropertyUsage
```
public NamedEntityDefinition withPropertyUsage(String propertyUsage)
```
    The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    Parameters:
    
    propertyUsage - The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyUsage
  - withPropertyUsage
```
public NamedEntityDefinition withPropertyUsage(PropertyUsage propertyUsage)
```
    The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    Parameters:
    
    propertyUsage - The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyUsage
  - setMetric
```
public void setMetric(NamedEntityDefinitionMetric metric)
```
    The definition of a metric.
    
    Parameters:
    
    metric - The definition of a metric.
  - getMetric
```
public NamedEntityDefinitionMetric getMetric()
```
    The definition of a metric.
    
    Returns:
    
    The definition of a metric.
  - withMetric
```
public NamedEntityDefinition withMetric(NamedEntityDefinitionMetric metric)
```
    The definition of a metric.
    
    Parameters:
    
    metric - The definition of a metric.
    
    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 NamedEntityDefinition 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class NamedEntityDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NamedEntityDefinition

Method Detail

setFieldName

getFieldName

withFieldName

setPropertyName

getPropertyName

withPropertyName

setPropertyRole

getPropertyRole

withPropertyRole

withPropertyRole

setPropertyUsage

getPropertyUsage

withPropertyUsage

withPropertyUsage

setMetric

getMetric

withMetric

toString

equals

hashCode

clone

marshall