Skip to content

KeywordLib

This class encapsulates and extends the ROS resource type ALIYUN::Aligreen::KeywordLib.

Initializers

import com.aliyun.ros.cdk.aligreen.KeywordLib;
KeywordLib.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .keywordLibName(java.lang.String)
    .keywordLibName(IResolvable)
    .resourceType(java.lang.String)
    .resourceType(IResolvable)
//  .bizTypes(IResolvable)
//  .bizTypes(java.util.List<java.lang.String)
//  .bizTypes(IResolvable>)
//  .category(java.lang.String)
//  .category(IResolvable)
//  .enable(java.lang.Boolean)
//  .enable(IResolvable)
//  .language(java.lang.String)
//  .language(IResolvable)
//  .libType(java.lang.String)
//  .libType(IResolvable)
//  .matchMode(java.lang.String)
//  .matchMode(IResolvable)
    .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.
keywordLibName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keywordLibName: The name of the keyword library defined by the customer.
resourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceType: The moderation scenario to which the text library applies.
bizTypes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property bizTypes: The business scenario.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The category of the text library.
enable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enable: Specifies whether to enable text library.true: Enable the text library. This is the default value.false: Disable the text library.
language java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property language: Language used by the text Library.
libType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property libType: The category of the text library in each moderation scenario.
matchMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property matchMode: The matching method.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

keywordLibNameRequired

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

Property keywordLibName: The name of the keyword library defined by the customer.

It can contain no more than 20 characters in Chinese, English, and underscore (_).


resourceTypeRequired

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

Property resourceType: The moderation scenario to which the text library applies.

Valid values:TEXT: text anti-spam、IMAGE: ad violation detection、VOICE: audio anti-spam.


bizTypesOptional

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

Property bizTypes: The business scenario.

Example:["bizTypeA","bizTypeB"].


categoryOptional

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

Property category: The category of the text library.

Valid values: BLACK: a blacklist. WHITE: a whitelist. REVIEW: a review list.


enableOptional

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

Property enable: Specifies whether to enable text library.true: Enable the text library. This is the default value.false: Disable the text library.


languageOptional

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

Property language: Language used by the text Library.

Example: zh:Chinese、en:English


libTypeOptional

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

Property libType: The category of the text library in each moderation scenario.

Valid values: textKeyword: a text library against which terms in text are matched. similarText: a text library against which text patterns are matched. voiceText: a text library against which terms converted from audio are matched.


matchModeOptional

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

Property matchMode: The matching method.

Valid values:fuzzy: fuzzy match precise: exact match.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.aligreen.KeywordLib;
KeywordLib.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
attrBizTypes java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BizTypes: The business scenario.
attrCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Category: The category of the text library.
attrEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Enable: Specifies whether to enable text library.
attrKeywordLibId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KeywordLibId: The ID of the primary key of the keyword library.
attrKeywordLibName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute KeywordLibName: The name of the keyword library defined by the customer.
attrLanguage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Language: Language used by the text Library.
attrLibType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LibType: The category of the text library in each moderation scenario.
attrMatchMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MatchMode: The matching method.
attrResourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceType: The moderation scenario to which the text library applies.
props KeywordLibProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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

attrBizTypesRequired

public java.lang.Object getAttrBizTypes();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BizTypes: The business scenario.


attrCategoryRequired

public java.lang.Object getAttrCategory();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Category: The category of the text library.


attrEnableRequired

public java.lang.Object getAttrEnable();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Enable: Specifies whether to enable text library.


attrKeywordLibIdRequired

public java.lang.Object getAttrKeywordLibId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute KeywordLibId: The ID of the primary key of the keyword library.


attrKeywordLibNameRequired

public java.lang.Object getAttrKeywordLibName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute KeywordLibName: The name of the keyword library defined by the customer.


attrLanguageRequired

public java.lang.Object getAttrLanguage();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Language: Language used by the text Library.


attrLibTypeRequired

public java.lang.Object getAttrLibType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LibType: The category of the text library in each moderation scenario.


attrMatchModeRequired

public java.lang.Object getAttrMatchMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MatchMode: The matching method.


attrResourceTypeRequired

public java.lang.Object getAttrResourceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceType: The moderation scenario to which the text library applies.


propsRequired

public KeywordLibProps getProps();