File OpenSearch/Namespaces/FlowFrameworkNamespace.php

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

49:

*

50:

* @param array $params Associative array of parameters

51:

* @return array

52:

*/

53:

public function create(array $params = [])

54:

{

55:

$body = $this->extractArgument($params, 'body');

56:

57:

$endpoint = $this->endpointFactory->getEndpoint(Create::class);

58:

$endpoint->setParams($params);

59:

$endpoint->setBody($body);

60:

61:

return $this->performRequest($endpoint);

}

/**

* Deletes a workflow template.

66:

*

67:

* $params['workflow_id'] = (string)

68:

* $params['clear_status'] = (boolean) (Default = false)

69:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

70:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

71:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

72:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

73:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

74:

*

75:

* @param array $params Associative array of parameters

76:

* @return array

77:

*/

78:

public function delete(array $params = [])

79:

{

80:

$workflow_id = $this->extractArgument($params, 'workflow_id');

81:

82:

$endpoint = $this->endpointFactory->getEndpoint(Delete::class);

83:

$endpoint->setParams($params);

84:

$endpoint->setWorkflowId($workflow_id);

85:

86:

return $this->performRequest($endpoint);

}

/**

* Deprovision workflow's resources when you no longer need them.

91:

*

92:

* $params['workflow_id'] = (string)

93:

* $params['allow_delete'] = (string)

94:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

95:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

96:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

97:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

98:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

99:

*

100:

* @param array $params Associative array of parameters

101:

* @return array

102:

*/

103:

public function deprovision(array $params = [])

104:

{

105:

$workflow_id = $this->extractArgument($params, 'workflow_id');

106:

107:

$endpoint = $this->endpointFactory->getEndpoint(Deprovision::class);

108:

$endpoint->setParams($params);

109:

$endpoint->setWorkflowId($workflow_id);

110:

111:

return $this->performRequest($endpoint);

}

/**

* Retrieves a workflow template.

116:

*

117:

* $params['workflow_id'] = (string)

118:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

119:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

120:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

121:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

122:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

123:

*

124:

* @param array $params Associative array of parameters

125:

* @return array

126:

*/

127:

public function get(array $params = [])

128:

{

129:

$workflow_id = $this->extractArgument($params, 'workflow_id');

130:

131:

$endpoint = $this->endpointFactory->getEndpoint(Get::class);

132:

$endpoint->setParams($params);

133:

$endpoint->setWorkflowId($workflow_id);

134:

135:

return $this->performRequest($endpoint);

}

/**

* Retrieves the current workflow provisioning status.

140:

*

141:

* $params['workflow_id'] = (string)

142:

* $params['all'] = (boolean) Whether to return all fields in the response. (Default = false)

143:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

144:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

145:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

146:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

147:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

148:

*

149:

* @param array $params Associative array of parameters

150:

* @return array

151:

*/

152:

public function getStatus(array $params = [])

153:

{

154:

$workflow_id = $this->extractArgument($params, 'workflow_id');

155:

156:

$endpoint = $this->endpointFactory->getEndpoint(GetStatus::class);

157:

$endpoint->setParams($params);

158:

$endpoint->setWorkflowId($workflow_id);

159:

160:

return $this->performRequest($endpoint);

}

/**

* Retrieves available workflow steps.

165:

*

166:

* $params['workflow_step'] = (string)

167:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

168:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

169:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

170:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

171:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

172:

*

173:

* @param array $params Associative array of parameters

174:

* @return array

175:

*/

176:

public function getSteps(array $params = [])

177:

{

178:

$endpoint = $this->endpointFactory->getEndpoint(GetSteps::class);

179:

$endpoint->setParams($params);

180:

181:

return $this->performRequest($endpoint);

}

/**

* Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true.

186:

*

187:

* $params['workflow_id'] = (string)

188:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

189:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

190:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

191:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

192:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

193:

*

194:

* @param array $params Associative array of parameters

195:

* @return array

196:

*/

197:

public function provision(array $params = [])

198:

{

199:

$workflow_id = $this->extractArgument($params, 'workflow_id');

200:

$body = $this->extractArgument($params, 'body');

201:

202:

$endpoint = $this->endpointFactory->getEndpoint(Provision::class);

203:

$endpoint->setParams($params);

204:

$endpoint->setWorkflowId($workflow_id);

205:

$endpoint->setBody($body);

206:

207:

return $this->performRequest($endpoint);

}

/**

* Search for workflows by using a query matching a field.

212:

*

213:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

214:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

215:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

216:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

217:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

218:

*

219:

* @param array $params Associative array of parameters

220:

* @return array

221:

*/

222:

public function search(array $params = [])

223:

{

224:

$body = $this->extractArgument($params, 'body');

225:

226:

$endpoint = $this->endpointFactory->getEndpoint(Search::class);

227:

$endpoint->setParams($params);

228:

$endpoint->setBody($body);

229:

230:

return $this->performRequest($endpoint);

}

/**

* Search for workflows by using a query matching a field.

235:

*

236:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

237:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

238:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

239:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

240:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

241:

*

242:

* @param array $params Associative array of parameters

243:

* @return array

244:

*/

245:

public function searchState(array $params = [])

246:

{

247:

$body = $this->extractArgument($params, 'body');

248:

249:

$endpoint = $this->endpointFactory->getEndpoint(SearchState::class);

250:

$endpoint->setParams($params);

251:

$endpoint->setBody($body);

252:

253:

return $this->performRequest($endpoint);

}

/**

* Updates a workflow template that has not been provisioned.

258:

*

259:

* $params['workflow_id'] = (string)

260:

* $params['provision'] = (boolean) (Default = false)

261:

* $params['reprovision'] = (boolean) (Default = false)

262:

* $params['update_fields'] = (boolean) (Default = false)

263:

* $params['use_case'] = (string) Specifies the workflow template to use.

264:

* $params['validation'] = (string) (Default = all)

265:

* $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)

266:

* $params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)

267:

* $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)

268:

* $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

269:

* $params['filter_path'] = (any) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.

270:

*

271:

* @param array $params Associative array of parameters

272:

* @return array

273:

*/

274:

public function update(array $params = [])

275:

{