SearchIndex

• Implements: ISearchIndex

This class encapsulates and extends the ROS resource type ALIYUN::OTS::SearchIndex.

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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

fieldSchemas^Required

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

Property fieldSchemas: list of field_schema.

indexName^Required

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

Property indexName: The index name.

instanceName^Required

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

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

tableName^Required

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

Property tableName: The table name of the OTS instance.

indexSetting^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR IndexSettingProperty

Property indexSetting: Index settings.

indexSort^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR IndexSortProperty

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

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrIndexName^Required

public java.lang.Object getAttrIndexName();

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

Attribute IndexName: Index name.

props^Required

public SearchIndexProps getProps();

• Type: SearchIndexProps