ApplyScenarioRequest (arms20190808 6.3.0 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.arms20190808.models.ApplyScenarioRequest

public class ApplyScenarioRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`appId` The ID of the application.
`Map<String,?>`	`config` The configuration of the business monitoring job.
`String`	`name` The name of the business monitoring job.
`String`	`regionId` The ID of the region.
`String`	`scenario` The scenario where you want to use the business monitoring job.
`String`	`sign` The code of the business monitoring job.
`Boolean`	`snDump` Specifies whether to record business parameters to the trace marked with the coloring sign.
`Boolean`	`snForce` Specifies whether traffic in the trace marked with the coloring sign is all collected.
`Boolean`	`snStat` Specifies whether to count traffic based on the coloring sign.
`Boolean`	`snTransfer` Specifies whether the coloring sign is transparently passed down to downstream application nodes in the trace.
`Boolean`	`updateOption` Specifies whether the operation is an update operation.

构造器概要

构造器
构造器和说明

ApplyScenarioRequest()

构造器
构造器和说明
`ApplyScenarioRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static ApplyScenarioRequest`	`build(Map<String,?> map)`
`String`	`getAppId()`
`Map<String,?>`	`getConfig()`
`String`	`getName()`
`String`	`getRegionId()`
`String`	`getScenario()`
`String`	`getSign()`
`Boolean`	`getSnDump()`
`Boolean`	`getSnForce()`
`Boolean`	`getSnStat()`
`Boolean`	`getSnTransfer()`
`Boolean`	`getUpdateOption()`
`ApplyScenarioRequest`	`setAppId(String appId)`
`ApplyScenarioRequest`	`setConfig(Map<String,?> config)`
`ApplyScenarioRequest`	`setName(String name)`
`ApplyScenarioRequest`	`setRegionId(String regionId)`
`ApplyScenarioRequest`	`setScenario(String scenario)`
`ApplyScenarioRequest`	`setSign(String sign)`
`ApplyScenarioRequest`	`setSnDump(Boolean snDump)`
`ApplyScenarioRequest`	`setSnForce(Boolean snForce)`
`ApplyScenarioRequest`	`setSnStat(Boolean snStat)`
`ApplyScenarioRequest`	`setSnTransfer(Boolean snTransfer)`
`ApplyScenarioRequest`	`setUpdateOption(Boolean updateOption)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - appId
```
@NameInMap(value="AppId")
public String appId
```
    The ID of the application.
    
    This parameter is required.
    example:
    b590lhguqs@28f515462f******
  - config
```
@NameInMap(value="Config")
public Map<String,?> config
```
    The configuration of the business monitoring job. The value is a JSON string. For more information about this parameter, see the following additional information about the Config parameter.
    
    This parameter is required.
    example:
    {"rpcType":"0","nameMatchType":"EQUALS","service":"/api/pop/test","operator":"and","filterItems":[{"type":"HttpHeaders","key":"uid","opt":"==","value":"123456789"}],"group":{"type":"HttpRequestParameters","key":"name"}}
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the business monitoring job.
    
    This parameter is required.
    example:
    ScenarioName
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The ID of the region.
    example:
    cn-zhangjaikou
  - scenario
```
@NameInMap(value="Scenario")
public String scenario
```
    The scenario where you want to use the business monitoring job. Valid values:
    - USER-DEFINED: user-defined. This is the default value.
    - EDAS-ROLLOUT: application release in Enterprise Distributed Application Service (EDAS)
    - OAM-ROLLOUT: application release based on Open Application Model (OAM)
    - MSC-CANARY: canary release based on Microservice Engine (MSE)
    example:
    USER-DEFINED
  - sign
```
@NameInMap(value="Sign")
public String sign
```
    The code of the business monitoring job. This parameter is not required when you create a business monitoring job. However, this parameter is required when you update a business monitoring job.
    example:
    a9f8****
  - snDump
```
@NameInMap(value="SnDump")
public Boolean snDump
```
    Specifies whether to record business parameters to the trace marked with the coloring sign.
    - true
    - false: This is the default value.
    example:
    false
  - snForce
```
@NameInMap(value="SnForce")
public Boolean snForce
```
    Specifies whether traffic in the trace marked with the coloring sign is all collected.
    - true
    - false: This is the default value.
    example:
    false
  - snStat
```
@NameInMap(value="SnStat")
public Boolean snStat
```
    Specifies whether to count traffic based on the coloring sign.
    - true
    - false: This is the default value.
    example:
    false
  - snTransfer
```
@NameInMap(value="SnTransfer")
public Boolean snTransfer
```
    Specifies whether the coloring sign is transparently passed down to downstream application nodes in the trace.
    - true
    - false: This is the default value.
    example:
    false
  - updateOption
```
@NameInMap(value="UpdateOption")
public Boolean updateOption
```
    Specifies whether the operation is an update operation.
    - true: update
    - false: insert
    This parameter is required.
    example:
    false
- 构造器详细资料
  - ApplyScenarioRequest
```
public ApplyScenarioRequest()
```
- 方法详细资料
  - build
```
public static ApplyScenarioRequest build(Map<String,?> map)
                                  throws Exception
```
    抛出:
    
    Exception
  - setAppId
```
public ApplyScenarioRequest setAppId(String appId)
```
  - getAppId
```
public String getAppId()
```
  - setConfig
```
public ApplyScenarioRequest setConfig(Map<String,?> config)
```
  - getConfig
```
public Map<String,?> getConfig()
```
  - setName
```
public ApplyScenarioRequest setName(String name)
```
  - getName
```
public String getName()
```
  - setRegionId
```
public ApplyScenarioRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setScenario
```
public ApplyScenarioRequest setScenario(String scenario)
```
  - getScenario
```
public String getScenario()
```
  - setSign
```
public ApplyScenarioRequest setSign(String sign)
```
  - getSign
```
public String getSign()
```
  - setSnDump
```
public ApplyScenarioRequest setSnDump(Boolean snDump)
```
  - getSnDump
```
public Boolean getSnDump()
```
  - setSnForce
```
public ApplyScenarioRequest setSnForce(Boolean snForce)
```
  - getSnForce
```
public Boolean getSnForce()
```
  - setSnStat
```
public ApplyScenarioRequest setSnStat(Boolean snStat)
```
  - getSnStat
```
public Boolean getSnStat()
```
  - setSnTransfer
```
public ApplyScenarioRequest setSnTransfer(Boolean snTransfer)
```
  - getSnTransfer
```
public Boolean getSnTransfer()
```
  - setUpdateOption
```
public ApplyScenarioRequest setUpdateOption(Boolean updateOption)
```
  - getUpdateOption
```
public Boolean getUpdateOption()
```

类 ApplyScenarioRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

appId

config

name

regionId

scenario

sign

snDump

snForce

snStat

snTransfer

updateOption

构造器详细资料

ApplyScenarioRequest

方法详细资料

build

setAppId

getAppId

setConfig

getConfig

setName

getName

setRegionId

getRegionId

setScenario

getScenario

setSign

getSign

setSnDump

getSnDump

setSnForce

getSnForce

setSnStat

getSnStat

setSnTransfer

getSnTransfer

setUpdateOption

getUpdateOption