RosIndex

This class is a base encapsulation around the ROS resource type ALIYUN::Bailian::Index.

Initializers

import com.aliyun.ros.cdk.bailian.RosIndex;
RosIndex.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .name(java.lang.String)
    .name(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
    .structureType(java.lang.String)
    .structureType(IResolvable)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .categoryIds(IResolvable)
//  .categoryIds(java.util.List<java.lang.String)
//  .categoryIds(IResolvable>)
//  .chunkMode(java.lang.String)
//  .chunkMode(IResolvable)
//  .chunkSize(java.lang.Number)
//  .chunkSize(IResolvable)
//  .connectId(java.lang.String)
//  .connectId(IResolvable)
//  .database(java.lang.String)
//  .database(IResolvable)
//  .denseSimilarityTopK(java.lang.Number)
//  .denseSimilarityTopK(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .documentIds(IResolvable)
//  .documentIds(java.util.List<java.lang.String)
//  .documentIds(IResolvable>)
//  .embeddingModelName(java.lang.String)
//  .embeddingModelName(IResolvable)
//  .enableHeaders(java.lang.Boolean)
//  .enableHeaders(IResolvable)
//  .enableRewrite(java.lang.Boolean)
//  .enableRewrite(IResolvable)
//  .knowledgeScene(java.lang.String)
//  .knowledgeScene(IResolvable)
//  .knowledgeType(java.lang.String)
//  .knowledgeType(IResolvable)
//  .metaExtractColumns(IResolvable)
//  .metaExtractColumns(java.util.List<IResolvable)
//  .metaExtractColumns(MetaExtractColumnsProperty>)
//  .overlapSize(java.lang.Number)
//  .overlapSize(IResolvable)
//  .pipelineCommercialCu(java.lang.Number)
//  .pipelineCommercialCu(IResolvable)
//  .pipelineCommercialType(java.lang.String)
//  .pipelineCommercialType(IResolvable)
//  .pipelineRetrieveRateLimitStrategy(java.lang.String)
//  .pipelineRetrieveRateLimitStrategy(IResolvable)
//  .rerankInstruct(java.lang.String)
//  .rerankInstruct(IResolvable)
//  .rerankMinScore(java.lang.Number)
//  .rerankMinScore(IResolvable)
//  .rerankMode(java.lang.String)
//  .rerankMode(IResolvable)
//  .rerankModelName(java.lang.String)
//  .rerankModelName(IResolvable)
//  .separator(java.lang.String)
//  .separator(IResolvable)
//  .sinkInstanceId(java.lang.String)
//  .sinkInstanceId(IResolvable)
//  .sinkRegion(java.lang.String)
//  .sinkRegion(IResolvable)
//  .sinkType(java.lang.String)
//  .sinkType(IResolvable)
//  .sparseSimilarityTopK(java.lang.Number)
//  .sparseSimilarityTopK(IResolvable)
//  .table(java.lang.String)
//  .table(IResolvable)
//  .tableIds(IResolvable)
//  .tableIds(java.util.List<java.lang.String)
//  .tableIds(IResolvable>)
    .build();

scope^Required

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

scope in which this resource is defined.

id^Required

• Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraint^Required

• Type: java.lang.Boolean

name^Required

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

sourceType^Required

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

structureType^Required

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

workspaceId^Required

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

categoryIds^Optional

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

chunkMode^Optional

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

chunkSize^Optional

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

connectId^Optional

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

database^Optional

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

denseSimilarityTopK^Optional

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

description^Optional

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

documentIds^Optional

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

embeddingModelName^Optional

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

enableHeaders^Optional

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

enableRewrite^Optional

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

knowledgeScene^Optional

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

knowledgeType^Optional

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

metaExtractColumns^Optional

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

overlapSize^Optional

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

pipelineCommercialCu^Optional

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

pipelineCommercialType^Optional

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

pipelineRetrieveRateLimitStrategy^Optional

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

rerankInstruct^Optional

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

rerankMinScore^Optional

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

rerankMode^Optional

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

rerankModelName^Optional

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

separator^Optional

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

sinkInstanceId^Optional

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

sinkRegion^Optional

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

sinkType^Optional

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

sparseSimilarityTopK^Optional

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

table^Optional

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

tableIds^Optional

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

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.

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: java.lang.String

The new logical ID to use for this stack element.

addCondition

public void addCondition(RosCondition con)

con^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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: java.lang.String

The path of the value to delete.

addDependsOn

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

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

addDesc

public void addDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

addMetaData

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: java.lang.String

The path to the property.

addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: java.lang.String

The path of the property.

value^Required

• Type: java.lang.Object

The value.

addRosDependency

public void addRosDependency(java.lang.String target)

target^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

options^Optional

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

fetchCondition

public RosCondition fetchCondition()

fetchDesc

public java.lang.String fetchDesc()

fetchRosDependency

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

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeName^Required

• Type: java.lang.String

The name of the attribute.

Static Functions

isConstruct

import com.aliyun.ros.cdk.bailian.RosIndex;
RosIndex.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.bailian.RosIndex;
RosIndex.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: java.lang.Object

isRosResource

import com.aliyun.ros.cdk.bailian.RosIndex;
RosIndex.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

creationStack^Required

public java.util.List<java.lang.String> getCreationStack();

• Type: java.util.List

logicalId^Required

public java.lang.String getLogicalId();

• Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

public Stack getStack();

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptions^Required

public IRosResourceOptions getRosOptions();

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

Options for this resource, such as condition, update policy etc.

rosResourceType^Required

public java.lang.String getRosResourceType();

• Type: java.lang.String

ROS resource type.

attrId^Required

public IResolvable getAttrId();

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

enableResourcePropertyConstraint^Required

public java.lang.Boolean getEnableResourcePropertyConstraint();

• Type: java.lang.Boolean

name^Required

public java.lang.Object getName();

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

sourceType^Required

public java.lang.Object getSourceType();

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

structureType^Required

public java.lang.Object getStructureType();

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

workspaceId^Required

public java.lang.Object getWorkspaceId();

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

categoryIds^Optional

public java.lang.Object getCategoryIds();

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

chunkMode^Optional

public java.lang.Object getChunkMode();

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

chunkSize^Optional

public java.lang.Object getChunkSize();

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

connectId^Optional

public java.lang.Object getConnectId();

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

database^Optional

public java.lang.Object getDatabase();

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

denseSimilarityTopK^Optional

public java.lang.Object getDenseSimilarityTopK();

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

description^Optional

public java.lang.Object getDescription();

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

documentIds^Optional

public java.lang.Object getDocumentIds();

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

embeddingModelName^Optional

public java.lang.Object getEmbeddingModelName();

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

enableHeaders^Optional

public java.lang.Object getEnableHeaders();

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

enableRewrite^Optional

public java.lang.Object getEnableRewrite();

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

knowledgeScene^Optional

public java.lang.Object getKnowledgeScene();

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

knowledgeType^Optional

public java.lang.Object getKnowledgeType();

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

metaExtractColumns^Optional

public java.lang.Object getMetaExtractColumns();

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

overlapSize^Optional

public java.lang.Object getOverlapSize();

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

pipelineCommercialCu^Optional

public java.lang.Object getPipelineCommercialCu();

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

pipelineCommercialType^Optional

public java.lang.Object getPipelineCommercialType();

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

pipelineRetrieveRateLimitStrategy^Optional

public java.lang.Object getPipelineRetrieveRateLimitStrategy();

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

rerankInstruct^Optional

public java.lang.Object getRerankInstruct();

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

rerankMinScore^Optional

public java.lang.Object getRerankMinScore();

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

rerankMode^Optional

public java.lang.Object getRerankMode();

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

rerankModelName^Optional

public java.lang.Object getRerankModelName();

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

separator^Optional

public java.lang.Object getSeparator();

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

sinkInstanceId^Optional

public java.lang.Object getSinkInstanceId();

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

sinkRegion^Optional

public java.lang.Object getSinkRegion();

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

sinkType^Optional

public java.lang.Object getSinkType();

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

sparseSimilarityTopK^Optional

public java.lang.Object getSparseSimilarityTopK();

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

table^Optional

public java.lang.Object getTable();

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

tableIds^Optional

public java.lang.Object getTableIds();

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

public java.lang.String getRosResourceTypeName();

• Type: java.lang.String

The resource type name for this resource class.

Structs