Documentation
¶
Index ¶
- Constants
- type Client
- func (c *Client) CreateFlowService(request *CreateFlowServiceRequest) (response *CreateFlowServiceResponse, err error)
- func (c *Client) DescribeExecution(request *DescribeExecutionRequest) (response *DescribeExecutionResponse, err error)
- func (c *Client) DescribeExecutions(request *DescribeExecutionsRequest) (response *DescribeExecutionsResponse, err error)
- func (c *Client) DescribeFlowServiceDetail(request *DescribeFlowServiceDetailRequest) (response *DescribeFlowServiceDetailResponse, err error)
- func (c *Client) DescribeFlowServices(request *DescribeFlowServicesRequest) (response *DescribeFlowServicesResponse, err error)
- func (c *Client) ModifyFlowService(request *ModifyFlowServiceRequest) (response *ModifyFlowServiceResponse, err error)
- func (c *Client) StartExecution(request *StartExecutionRequest) (response *StartExecutionResponse, err error)
- type CreateFlowServiceRequest
- type CreateFlowServiceResponse
- type DescribeExecutionRequest
- type DescribeExecutionResponse
- type DescribeExecutionsRequest
- type DescribeExecutionsResponse
- type DescribeFlowServiceDetailRequest
- type DescribeFlowServiceDetailResponse
- type DescribeFlowServicesRequest
- type DescribeFlowServicesResponse
- type Filter
- type ModifyFlowServiceRequest
- type ModifyFlowServiceResponse
- type StartExecutionRequest
- type StartExecutionResponse
- type StateMachine
Constants ¶
View Source
const APIVersion = "2020-07-22"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
func NewClient ¶
func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateFlowService ¶
func (c *Client) CreateFlowService(request *CreateFlowServiceRequest) (response *CreateFlowServiceResponse, err error)
该接口用于生成状态机服务
func (*Client) DescribeExecution ¶
func (c *Client) DescribeExecution(request *DescribeExecutionRequest) (response *DescribeExecutionResponse, err error)
查询执行详细信息
func (*Client) DescribeExecutions ¶
func (c *Client) DescribeExecutions(request *DescribeExecutionsRequest) (response *DescribeExecutionsResponse, err error)
对状态机的执行历史进行描述.
func (*Client) DescribeFlowServiceDetail ¶
func (c *Client) DescribeFlowServiceDetail(request *DescribeFlowServiceDetailRequest) (response *DescribeFlowServiceDetailResponse, err error)
查询该用户指定状态机下的详情数据。
func (*Client) DescribeFlowServices ¶ added in v1.0.53
func (c *Client) DescribeFlowServices(request *DescribeFlowServicesRequest) (response *DescribeFlowServicesResponse, err error)
查询指定用户下所有状态机,以列表形式返回
func (*Client) ModifyFlowService ¶
func (c *Client) ModifyFlowService(request *ModifyFlowServiceRequest) (response *ModifyFlowServiceResponse, err error)
该接口用于修改状态机
func (*Client) StartExecution ¶
func (c *Client) StartExecution(request *StartExecutionRequest) (response *StartExecutionResponse, err error)
为指定的状态机启动一次执行
type CreateFlowServiceRequest ¶
type CreateFlowServiceRequest struct {
*tchttp.BaseRequest
// 定义文本(JSON格式)
Definition *string `json:"Definition,omitempty" name:"Definition"`
// 状态机所属服务名
FlowServiceName *string `json:"FlowServiceName,omitempty" name:"FlowServiceName"`
// 是不是新的角色
IsNewRole *bool `json:"IsNewRole,omitempty" name:"IsNewRole"`
// 状态机类型(EXPRESS,STANDARD)
Type *string `json:"Type,omitempty" name:"Type"`
// 状态机所属服务中文名
FlowServiceChineseName *string `json:"FlowServiceChineseName,omitempty" name:"FlowServiceChineseName"`
// 角色资源名, 比如: qcs::cam::uin/20103392:roleName/SomeRoleForYourStateMachine
RoleResource *string `json:"RoleResource,omitempty" name:"RoleResource"`
// 备注
Description *string `json:"Description,omitempty" name:"Description"`
}
func NewCreateFlowServiceRequest ¶
func NewCreateFlowServiceRequest() (request *CreateFlowServiceRequest)
func (*CreateFlowServiceRequest) FromJsonString ¶
func (r *CreateFlowServiceRequest) FromJsonString(s string) error
func (*CreateFlowServiceRequest) ToJsonString ¶
func (r *CreateFlowServiceRequest) ToJsonString() string
type CreateFlowServiceResponse ¶
type CreateFlowServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 状态机所属服务资源
FlowServiceResource *string `json:"FlowServiceResource,omitempty" name:"FlowServiceResource"`
// 生成日期
CreateDate *string `json:"CreateDate,omitempty" name:"CreateDate"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewCreateFlowServiceResponse ¶
func NewCreateFlowServiceResponse() (response *CreateFlowServiceResponse)
func (*CreateFlowServiceResponse) FromJsonString ¶
func (r *CreateFlowServiceResponse) FromJsonString(s string) error
func (*CreateFlowServiceResponse) ToJsonString ¶
func (r *CreateFlowServiceResponse) ToJsonString() string
type DescribeExecutionRequest ¶
type DescribeExecutionRequest struct {
*tchttp.BaseRequest
// 执行资源名
ExecutionResourceName *string `json:"ExecutionResourceName,omitempty" name:"ExecutionResourceName"`
}
func NewDescribeExecutionRequest ¶
func NewDescribeExecutionRequest() (request *DescribeExecutionRequest)
func (*DescribeExecutionRequest) FromJsonString ¶
func (r *DescribeExecutionRequest) FromJsonString(s string) error
func (*DescribeExecutionRequest) ToJsonString ¶
func (r *DescribeExecutionRequest) ToJsonString() string
type DescribeExecutionResponse ¶
type DescribeExecutionResponse struct {
*tchttp.BaseResponse
Response *struct {
// 执行资源名
ExecutionResourceName *string `json:"ExecutionResourceName,omitempty" name:"ExecutionResourceName"`
// 资源名称
Name *string `json:"Name,omitempty" name:"Name"`
// 执行开始时间,毫秒
StartDate *string `json:"StartDate,omitempty" name:"StartDate"`
// 执行结束时间,毫秒
StopDate *string `json:"StopDate,omitempty" name:"StopDate"`
// 状态机资源名
StateMachineResourceName *string `json:"StateMachineResourceName,omitempty" name:"StateMachineResourceName"`
// 执行状态。INIT,RUNNING,SUCCEED,FAILED,TERMINATED
Status *string `json:"Status,omitempty" name:"Status"`
// 执行的输入
// 注意:此字段可能返回 null,表示取不到有效值。
Input *string `json:"Input,omitempty" name:"Input"`
// 执行的输出
// 注意:此字段可能返回 null,表示取不到有效值。
Output *string `json:"Output,omitempty" name:"Output"`
// 启动执行时,状态机的定义
ExecutionDefinition *string `json:"ExecutionDefinition,omitempty" name:"ExecutionDefinition"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeExecutionResponse ¶
func NewDescribeExecutionResponse() (response *DescribeExecutionResponse)
func (*DescribeExecutionResponse) FromJsonString ¶
func (r *DescribeExecutionResponse) FromJsonString(s string) error
func (*DescribeExecutionResponse) ToJsonString ¶
func (r *DescribeExecutionResponse) ToJsonString() string
type DescribeExecutionsRequest ¶
type DescribeExecutionsRequest struct {
*tchttp.BaseRequest
// 状态机资源名
StateMachineResourceName *string `json:"StateMachineResourceName,omitempty" name:"StateMachineResourceName"`
// 页大小,最大100
PageSize *int64 `json:"PageSize,omitempty" name:"PageSize"`
// 页序号,从1开始
PageIndex *int64 `json:"PageIndex,omitempty" name:"PageIndex"`
// 按状态过滤条件,INIT,RUNNING,SUCCEED,FAILED,TERMINATED
FilterExecutionStatus *string `json:"FilterExecutionStatus,omitempty" name:"FilterExecutionStatus"`
// 按执行名过滤条件
FilterExecutionResourceName *string `json:"FilterExecutionResourceName,omitempty" name:"FilterExecutionResourceName"`
}
func NewDescribeExecutionsRequest ¶
func NewDescribeExecutionsRequest() (request *DescribeExecutionsRequest)
func (*DescribeExecutionsRequest) FromJsonString ¶
func (r *DescribeExecutionsRequest) FromJsonString(s string) error
func (*DescribeExecutionsRequest) ToJsonString ¶
func (r *DescribeExecutionsRequest) ToJsonString() string
type DescribeExecutionsResponse ¶
type DescribeExecutionsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeExecutionsResponse ¶
func NewDescribeExecutionsResponse() (response *DescribeExecutionsResponse)
func (*DescribeExecutionsResponse) FromJsonString ¶
func (r *DescribeExecutionsResponse) FromJsonString(s string) error
func (*DescribeExecutionsResponse) ToJsonString ¶
func (r *DescribeExecutionsResponse) ToJsonString() string
type DescribeFlowServiceDetailRequest ¶
type DescribeFlowServiceDetailRequest struct {
*tchttp.BaseRequest
// 状态机所属服务资源名
FlowServiceResource *string `json:"FlowServiceResource,omitempty" name:"FlowServiceResource"`
}
func NewDescribeFlowServiceDetailRequest ¶
func NewDescribeFlowServiceDetailRequest() (request *DescribeFlowServiceDetailRequest)
func (*DescribeFlowServiceDetailRequest) FromJsonString ¶
func (r *DescribeFlowServiceDetailRequest) FromJsonString(s string) error
func (*DescribeFlowServiceDetailRequest) ToJsonString ¶
func (r *DescribeFlowServiceDetailRequest) ToJsonString() string
type DescribeFlowServiceDetailResponse ¶
type DescribeFlowServiceDetailResponse struct {
*tchttp.BaseResponse
Response *struct {
// 状态机所属服务名
FlowServiceName *string `json:"FlowServiceName,omitempty" name:"FlowServiceName"`
// 状态机状态
Status *string `json:"Status,omitempty" name:"Status"`
// 定义文本(JSON格式)
// 注意:此字段可能返回 null,表示取不到有效值。
Definition *string `json:"Definition,omitempty" name:"Definition"`
// 角色资源名
// 注意:此字段可能返回 null,表示取不到有效值。
RoleResource *string `json:"RoleResource,omitempty" name:"RoleResource"`
// 状态机的类型,可以为 (EXPRESS/STANDARD)
Type *string `json:"Type,omitempty" name:"Type"`
// 生成时间
CreateDate *string `json:"CreateDate,omitempty" name:"CreateDate"`
// 备注
// 注意:此字段可能返回 null,表示取不到有效值。
Description *string `json:"Description,omitempty" name:"Description"`
// 状态机所属服务中文名
// 注意:此字段可能返回 null,表示取不到有效值。
FlowServiceChineseName *string `json:"FlowServiceChineseName,omitempty" name:"FlowServiceChineseName"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeFlowServiceDetailResponse ¶
func NewDescribeFlowServiceDetailResponse() (response *DescribeFlowServiceDetailResponse)
func (*DescribeFlowServiceDetailResponse) FromJsonString ¶
func (r *DescribeFlowServiceDetailResponse) FromJsonString(s string) error
func (*DescribeFlowServiceDetailResponse) ToJsonString ¶
func (r *DescribeFlowServiceDetailResponse) ToJsonString() string
type DescribeFlowServicesRequest ¶ added in v1.0.53
type DescribeFlowServicesRequest struct {
*tchttp.BaseRequest
// 偏移量,默认为0。
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 返回数量,默认为20,最大值为100。
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// 过滤条件,详见下表:实例过滤条件表。每次请求的Filter.Values的上限为5。参数名字仅支持FlowServiceName, Status, Type三种情况
Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}
func NewDescribeFlowServicesRequest ¶ added in v1.0.53
func NewDescribeFlowServicesRequest() (request *DescribeFlowServicesRequest)
func (*DescribeFlowServicesRequest) FromJsonString ¶ added in v1.0.53
func (r *DescribeFlowServicesRequest) FromJsonString(s string) error
func (*DescribeFlowServicesRequest) ToJsonString ¶ added in v1.0.53
func (r *DescribeFlowServicesRequest) ToJsonString() string
type DescribeFlowServicesResponse ¶ added in v1.0.53
type DescribeFlowServicesResponse struct {
*tchttp.BaseResponse
Response *struct {
// 用户的状态机列表
FlowServiceSet []*StateMachine `json:"FlowServiceSet,omitempty" name:"FlowServiceSet" list`
// 用户的状态机总数
TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeFlowServicesResponse ¶ added in v1.0.53
func NewDescribeFlowServicesResponse() (response *DescribeFlowServicesResponse)
func (*DescribeFlowServicesResponse) FromJsonString ¶ added in v1.0.53
func (r *DescribeFlowServicesResponse) FromJsonString(s string) error
func (*DescribeFlowServicesResponse) ToJsonString ¶ added in v1.0.53
func (r *DescribeFlowServicesResponse) ToJsonString() string
type ModifyFlowServiceRequest ¶
type ModifyFlowServiceRequest struct {
*tchttp.BaseRequest
// 状态机资源名
FlowServiceResource *string `json:"FlowServiceResource,omitempty" name:"FlowServiceResource"`
// 定义JSON
Definition *string `json:"Definition,omitempty" name:"Definition"`
// 状态机所属服务名
FlowServiceName *string `json:"FlowServiceName,omitempty" name:"FlowServiceName"`
// 状态机所属服务中文名
FlowServiceChineseName *string `json:"FlowServiceChineseName,omitempty" name:"FlowServiceChineseName"`
// 是否是新角色
IsNewRole *bool `json:"IsNewRole,omitempty" name:"IsNewRole"`
// 状态机类型
Type *string `json:"Type,omitempty" name:"Type"`
// 角色资源名
RoleResource *string `json:"RoleResource,omitempty" name:"RoleResource"`
// 状态机备注
Description *string `json:"Description,omitempty" name:"Description"`
}
func NewModifyFlowServiceRequest ¶
func NewModifyFlowServiceRequest() (request *ModifyFlowServiceRequest)
func (*ModifyFlowServiceRequest) FromJsonString ¶
func (r *ModifyFlowServiceRequest) FromJsonString(s string) error
func (*ModifyFlowServiceRequest) ToJsonString ¶
func (r *ModifyFlowServiceRequest) ToJsonString() string
type ModifyFlowServiceResponse ¶
type ModifyFlowServiceResponse struct {
*tchttp.BaseResponse
Response *struct {
// 状态机资源名
FlowServiceResource *string `json:"FlowServiceResource,omitempty" name:"FlowServiceResource"`
// 更新时间
UpdateDate *string `json:"UpdateDate,omitempty" name:"UpdateDate"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewModifyFlowServiceResponse ¶
func NewModifyFlowServiceResponse() (response *ModifyFlowServiceResponse)
func (*ModifyFlowServiceResponse) FromJsonString ¶
func (r *ModifyFlowServiceResponse) FromJsonString(s string) error
func (*ModifyFlowServiceResponse) ToJsonString ¶
func (r *ModifyFlowServiceResponse) ToJsonString() string
type StartExecutionRequest ¶
type StartExecutionRequest struct {
*tchttp.BaseRequest
// 状态机资源名
StateMachineResourceName *string `json:"StateMachineResourceName,omitempty" name:"StateMachineResourceName"`
// 输入参数
Input *string `json:"Input,omitempty" name:"Input"`
// 本次执行名。如果不填,系统会自动生成。如果填,应保证状态机下唯一
Name *string `json:"Name,omitempty" name:"Name"`
}
func NewStartExecutionRequest ¶
func NewStartExecutionRequest() (request *StartExecutionRequest)
func (*StartExecutionRequest) FromJsonString ¶
func (r *StartExecutionRequest) FromJsonString(s string) error
func (*StartExecutionRequest) ToJsonString ¶
func (r *StartExecutionRequest) ToJsonString() string
type StartExecutionResponse ¶
type StartExecutionResponse struct {
*tchttp.BaseResponse
Response *struct {
// 执行资源名
ExecutionResourceName *string `json:"ExecutionResourceName,omitempty" name:"ExecutionResourceName"`
// 执行开始时间
StartDate *string `json:"StartDate,omitempty" name:"StartDate"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewStartExecutionResponse ¶
func NewStartExecutionResponse() (response *StartExecutionResponse)
func (*StartExecutionResponse) FromJsonString ¶
func (r *StartExecutionResponse) FromJsonString(s string) error
func (*StartExecutionResponse) ToJsonString ¶
func (r *StartExecutionResponse) ToJsonString() string
type StateMachine ¶ added in v1.0.53
type StateMachine struct {
// 状态机资源
FlowServiceResource *string `json:"FlowServiceResource,omitempty" name:"FlowServiceResource"`
// 状态机类型。EXPRESS,STANDARD
Type *string `json:"Type,omitempty" name:"Type"`
// 状态机名称
FlowServiceName *string `json:"FlowServiceName,omitempty" name:"FlowServiceName"`
// 状态机中文名
FlowServiceChineseName *string `json:"FlowServiceChineseName,omitempty" name:"FlowServiceChineseName"`
// 创建时间。timestamp
CreateDate *string `json:"CreateDate,omitempty" name:"CreateDate"`
// 修改时间。timestamp
ModifyDate *string `json:"ModifyDate,omitempty" name:"ModifyDate"`
// 状态机状态
Status *string `json:"Status,omitempty" name:"Status"`
// 创建者的subAccountUin
// 注意:此字段可能返回 null,表示取不到有效值。
Creator *string `json:"Creator,omitempty" name:"Creator"`
// 修改者的subAccountUin
// 注意:此字段可能返回 null,表示取不到有效值。
Modifier *string `json:"Modifier,omitempty" name:"Modifier"`
// 状态机id
FlowServiceId *string `json:"FlowServiceId,omitempty" name:"FlowServiceId"`
// 模板id
TemplateId *string `json:"TemplateId,omitempty" name:"TemplateId"`
// 备注
Description *string `json:"Description,omitempty" name:"Description"`
}
Click to show internal directories.
Click to hide internal directories.