Package software.amazon.awscdk.services.quicksight

Interface CfnTopic.TopicNamedEntityProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopic.TopicNamedEntityProperty.Jsii$Proxy

Enclosing class:

CfnTopic

@Stability(Stable)
public static interface CfnTopic.TopicNamedEntityProperty
extends software.amazon.jsii.JsiiSerializable

A structure that represents a named entity.

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.quicksight.*;
 TopicNamedEntityProperty topicNamedEntityProperty = TopicNamedEntityProperty.builder()
         .entityName("entityName")
         // the properties below are optional
         .definition(List.of(NamedEntityDefinitionProperty.builder()
                 .fieldName("fieldName")
                 .metric(NamedEntityDefinitionMetricProperty.builder()
                         .aggregation("aggregation")
                         .aggregationFunctionParameters(Map.of(
                                 "aggregationFunctionParametersKey", "aggregationFunctionParameters"))
                         .build())
                 .propertyName("propertyName")
                 .propertyRole("propertyRole")
                 .propertyUsage("propertyUsage")
                 .build()))
         .entityDescription("entityDescription")
         .entitySynonyms(List.of("entitySynonyms"))
         .semanticEntityType(SemanticEntityTypeProperty.builder()
                 .subTypeName("subTypeName")
                 .typeName("typeName")
                 .typeParameters(Map.of(
                         "typeParametersKey", "typeParameters"))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopic.TopicNamedEntityProperty.Builder	builder()
default Object	getDefinition()	The definition of a named entity.
default String	getEntityDescription()	The description of the named entity.
String	getEntityName()	The name of the named entity.
default List<String>	getEntitySynonyms()	The other names or aliases for the named entity.
default Object	getSemanticEntityType()	The type of named entity that a topic represents.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityName

@Stability(Stable)
@NotNull
String getEntityName()

The name of the named entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entityname

getDefinition

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

The definition of a named entity.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopic.NamedEntityDefinitionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-definition

getEntityDescription

@Stability(Stable)
@Nullable
default String getEntityDescription()

The description of the named entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitydescription

getEntitySynonyms

@Stability(Stable)
@Nullable
default List<String> getEntitySynonyms()

The other names or aliases for the named entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitysynonyms

getSemanticEntityType

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

The type of named entity that a topic represents.

Returns union: either IResolvable or CfnTopic.SemanticEntityTypeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-semanticentitytype

builder

@Stability(Stable)
static CfnTopic.TopicNamedEntityProperty.Builder builder()

Returns:

a CfnTopic.TopicNamedEntityProperty.Builder of CfnTopic.TopicNamedEntityProperty