InsertMediaToSearchLib

This class encapsulates and extends the ROS resource type ALIYUN::ICE::InsertMediaToSearchLib.

Initializers

import com.aliyun.ros.cdk.ice.InsertMediaToSearchLib;
InsertMediaToSearchLib.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .input(java.lang.String)
    .input(IResolvable)
//  .mediaId(java.lang.String)
//  .mediaId(IResolvable)
//  .mediaType(java.lang.String)
//  .mediaType(IResolvable)
//  .msgBody(IResolvable)
//  .msgBody(java.util.Map<java.lang.String, java.lang.Object>)
//  .searchLibName(java.lang.String)
//  .searchLibName(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.
input	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property input: The URL of the video, audio, or image file that you want to import to the search library.
mediaId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property mediaId: The ID of the media asset.
mediaType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property mediaType: The type of the media asset.
msgBody	com.aliyun.ros.cdk.core.IResolvable OR java.util.Map	Property msgBody: The message body.
searchLibName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property searchLibName: The name of the search library.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

input^Required

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

Property input: The URL of the video, audio, or image file that you want to import to the search library.

Note: Make sure that you specify a correct file name and the bucket in which the file resides is in the same region where this operation is called. Otherwise, the file cannot be found or the operation may fail. Specify an Object Storage Service (OSS) URL in the following format: oss://[Bucket name]/[File path]. For example, you can specify oss://[example-bucket-]/[object_path-]. Specify an HTTP URL in the following format: public endpoint. For example, you can specify http://example-test-****.mp4.

---

mediaId^Optional

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

Property mediaId: The ID of the media asset.

Each media ID is unique. If you leave this parameter empty, a media ID is automatically generated for this parameter.

---

mediaType^Optional

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

Property mediaType: The type of the media asset.

Valid values: video (default) image audio

---

msgBody^Optional

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

Property msgBody: The message body.

---

searchLibName^Optional

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

Property searchLibName: The name of the search library.

Default value: ims-default-search-lib.

---

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.

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

---

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

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

---

isConstruct

import com.aliyun.ros.cdk.ice.InsertMediaToSearchLib;
InsertMediaToSearchLib.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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.
attrMediaId	com.aliyun.ros.cdk.core.IResolvable	Attribute MediaId: The ID of the media asset.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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

---

attrMediaId^Required

public IResolvable getAttrMediaId();

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

Attribute MediaId: The ID of the media asset.

---