Skip to content

OperationProps

Properties for defining a Operation.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-operation

Initializer 

import ros_cdk_apig
ros_cdk_apig.OperationProps(
  http_api_id: typing.Union[str, IResolvable],
  method: typing.Union[str, IResolvable],
  operation_name: typing.Union[str, IResolvable],
  path: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  mock: typing.Union[IResolvable, MockProperty] = None
)

Properties

Name Type Description
http_api_id typing.Union[str, ros_cdk_core.IResolvable] Property httpApiId: The HTTP API ID to which the interface belongs.
method typing.Union[str, ros_cdk_core.IResolvable] Property method: The method of http protocol.
operation_name typing.Union[str, ros_cdk_core.IResolvable] Property operationName: The name of the operation.
path typing.Union[str, ros_cdk_core.IResolvable] Property path: The interface path of the operation.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the operation.
mock typing.Union[ros_cdk_core.IResolvable, MockProperty] Property mock: Mock configuration.

http_api_idRequired 

http_api_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

methodRequired 

method: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property method: The method of http protocol.

operation_nameRequired 

operation_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property operationName: The name of the operation.

pathRequired 

path: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property path: The interface path of the operation.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the operation.

mockOptional 

mock: typing.Union[IResolvable, MockProperty]
  • Type: typing.Union[ros_cdk_core.IResolvable, MockProperty]

Property mock: Mock configuration.