extends |
AbstractNamespace |
---|
Class FlowFrameworkNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
Methods | ||||
---|---|---|---|---|
public
|
create(array $params = []): array
Creates a new workflow template.
Creates a new workflow template. $params['provision'] = (boolean) (Default = false)
$params['reprovision'] = (boolean) (Default = false)
$params['update_fields'] = (boolean) (Default = false)
$params['use_case'] = (string) Specifies the workflow template to use.
$params['validation'] = (string) (Default = all)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
delete(array $params = []): array
Deletes a workflow template.
Deletes a workflow template. $params['workflow_id'] = (string)
$params['clear_status'] = (boolean) (Default = false)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
deprovision(array $params = []): array
Deprovision workflow's resources when you no longer need them.
Deprovision workflow's resources when you no longer need them. $params['workflow_id'] = (string)
$params['allow_delete'] = (string)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
get(array $params = []): array
Retrieves a workflow template.
Retrieves a workflow template. $params['workflow_id'] = (string)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
getStatus(array $params = []): array
Retrieves the current workflow provisioning status.
Retrieves the current workflow provisioning status. $params['workflow_id'] = (string)
$params['all'] = (boolean) Whether to return all fields in the response. (Default = false)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
getSteps(array $params = []): array
Retrieves available workflow steps.
Retrieves available workflow steps. $params['workflow_step'] = (string)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
provision(array $params = []): array
Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision…
Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true. $params['workflow_id'] = (string)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
search(array $params = []): array
Search for workflows by using a query matching a field.
Search for workflows by using a query matching a field. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
searchState(array $params = []): array
Search for workflows by using a query matching a field.
Search for workflows by using a query matching a field. $params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# | ||
public
|
update(array $params = []): array
Updates a workflow template that has not been provisioned.
Updates a workflow template that has not been provisioned. $params['workflow_id'] = (string)
$params['provision'] = (boolean) (Default = false)
$params['reprovision'] = (boolean) (Default = false)
$params['update_fields'] = (boolean) (Default = false)
$params['use_case'] = (string) Specifies the workflow template to use.
$params['validation'] = (string) (Default = all)
$params['pretty'] = (boolean) Whether to pretty-format the returned JSON response. (Default = false)
$params['human'] = (boolean) Whether to return human-readable values for statistics. (Default = false)
$params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false)
$params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
$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 Parameters
|
# |
Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
---|
__construct(), extractArgument(), performRequest() |
Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
---|
$transport, $httpTransport, $endpointFactory, $endpoints |