Skip to content

SearchIndex

This class encapsulates and extends the ROS resource type ALIYUN::OTS::SearchIndex, which is used to create a search index for a data table.

You can create multiple search indexes for a data table.

Initializers 

import com.aliyun.ros.cdk.ots.SearchIndex;
SearchIndex.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fieldSchemas(IResolvable)
    .fieldSchemas(java.util.List<IResolvable)
    .fieldSchemas(FieldSchemasProperty>)
    .indexName(java.lang.String)
    .indexName(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .tableName(java.lang.String)
    .tableName(IResolvable)
//  .indexSetting(IResolvable)
//  .indexSetting(IndexSettingProperty)
//  .indexSort(IResolvable)
//  .indexSort(IndexSortProperty)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
fieldSchemas com.aliyun.ros.cdk.core.IResolvable OR java.util.ListFieldSchemasProperty> Property fieldSchemas: list of field_schema.
indexName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property indexName: The index name.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the OTS instance in which table will locate.
tableName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tableName: The table name of the OTS instance.
indexSetting com.aliyun.ros.cdk.core.IResolvable OR IndexSettingProperty Property indexSetting: Index settings.
indexSort com.aliyun.ros.cdk.core.IResolvable OR IndexSortProperty Property indexSort: This parameter specifies how data is sorted.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

fieldSchemasRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListFieldSchemasProperty>

Property fieldSchemas: list of field_schema.

indexNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property indexName: The index name.

instanceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The name of the OTS instance in which table will locate.

tableNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tableName: The table name of the OTS instance.

indexSettingOptional

Property indexSetting: Index settings.

indexSortOptional

Property indexSort: This parameter specifies how data is sorted.

By default, the data is sorted in the same way as the primary key of the table. If the search index contains NESTED fields, data is not sorted by default.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ots.SearchIndex;
SearchIndex.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrIndexName com.aliyun.ros.cdk.core.IResolvable Attribute IndexName: Index name.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrIndexNameRequired 

public IResolvable getAttrIndexName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IndexName: Index name.