Operation

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Operation.

Initializers

import com.aliyun.ros.cdk.apig.Operation;
Operation.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .httpApiId(java.lang.String)
    .httpApiId(IResolvable)
    .method(java.lang.String)
    .method(IResolvable)
    .operationName(java.lang.String)
    .operationName(IResolvable)
    .path(java.lang.String)
    .path(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .mock(IResolvable)
//  .mock(MockProperty)
    .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.
`httpApiId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property httpApiId: The HTTP API ID to which the interface belongs.
`method`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property method: The method of http protocol.
`operationName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property operationName: The name of the operation.
`path`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property path: The interface path of the operation.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: The description of the operation.
`mock`	`com.aliyun.ros.cdk.core.IResolvable OR MockProperty`	Property mock: Mock configuration.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`httpApiId`^Required

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

Property httpApiId: The HTTP API ID to which the interface belongs.

`method`^Required

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

Property method: The method of http protocol.

`operationName`^Required

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

Property operationName: The name of the operation.

`path`^Required

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

Property path: The interface path of the operation.

`description`^Optional

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

Property description: The description of the operation.

`mock`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR MockProperty

Property mock: Mock configuration.

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.apig.Operation;
Operation.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.
`attrCreateTime`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CreateTime: The creation timestamp of the operation.
`attrDescription`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Description: The description of the operation.
`attrMethod`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Method: The method of http protocol.
`attrMock`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Mock: Mock configuration.
`attrOperationId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute OperationId: The ID of the operation.
`attrOperationName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute OperationName: The name of the resource.
`attrPath`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Path: The interface path of the operation.

`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

`attrCreateTime`^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The creation timestamp of the operation.

`attrDescription`^Required

public IResolvable getAttrDescription();

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

Attribute Description: The description of the operation.

`attrMethod`^Required

public IResolvable getAttrMethod();

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

Attribute Method: The method of http protocol.

`attrMock`^Required

public IResolvable getAttrMock();

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

Attribute Mock: Mock configuration.

`attrOperationId`^Required

public IResolvable getAttrOperationId();

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

Attribute OperationId: The ID of the operation.

`attrOperationName`^Required

public IResolvable getAttrOperationName();

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

Attribute OperationName: The name of the resource.

`attrPath`^Required

public IResolvable getAttrPath();

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

Attribute Path: The interface path of the operation.

Operation

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

httpApiIdRequired

methodRequired

operationNameRequired

pathRequired

descriptionOptional

mockOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata