/ 
OpenSearch-Client-3.007004
/ OpenSearch::Client::Core::3_0::Direct::FlowFramework

NAME

OpenSearch::Client::Core::3_0::Direct::FlowFramework

VERSION

version 3.007004

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->flow_framework-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Automating configurations

You can automate complex OpenSearch setup and preprocessing tasks by providing templates for common use cases. For example, automating machine learning (ML) setup tasks streamlines the use of OpenSearch ML offerings.

See OpenSearch documentation for flow_framework.

METHODS

flow_framework->create

Creates a new workflow template.

Paths served by this method:

POST /_plugins/_flow_framework/workflow
$resp = $client->flow_framework->create(
    
    'body'           =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'provision'      =>  $qval1,     # boolean
    'reprovision'    =>  $qval2,     # boolean
    'update_fields'  =>  $qval3,     # boolean
    'use_case'       =>  $qval4,     # string
    'validation'     =>  $qval5,     # string
    
     # Common API query string parameters
    
    'error_trace'    =>  $qval6,     # boolean
    'filter_path'    =>  $qval7,     # list
    'human'          =>  $qval8,     # boolean
    'pretty'         =>  $qval9,     # boolean
    'source'         =>  $qval10,    # string
);

OpenSearch documentation for flow_framework.create

flow_framework->delete

Deletes a workflow template.

Paths served by this method:

DELETE /_plugins/_flow_framework/workflow/{workflow_id}
$resp = $client->flow_framework->delete(
    
     # path parameters
    
    'workflow_id'   =>  $workflow_id,  # required
    
     # Endpoint specific query string parameters
    
    'clear_status'  =>  $qval1,     # boolean
    
     # Common API query string parameters
    
    'error_trace'   =>  $qval2,     # boolean
    'filter_path'   =>  $qval3,     # list
    'human'         =>  $qval4,     # boolean
    'pretty'        =>  $qval5,     # boolean
    'source'        =>  $qval6,     # string
);

OpenSearch documentation for flow_framework.delete

flow_framework->deprovision

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

Paths served by this method:

POST /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision
$resp = $client->flow_framework->deprovision(
    
     # path parameters
    
    'workflow_id'   =>  $workflow_id,  # required
    
     # Endpoint specific query string parameters
    
    'allow_delete'  =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'   =>  $qval2,     # boolean
    'filter_path'   =>  $qval3,     # list
    'human'         =>  $qval4,     # boolean
    'pretty'        =>  $qval5,     # boolean
    'source'        =>  $qval6,     # string
);

OpenSearch documentation for flow_framework.deprovision

flow_framework->get

Retrieves a workflow template.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/{workflow_id}
$resp = $client->flow_framework->get(
    
     # path parameters
    
    'workflow_id'  =>  $workflow_id,  # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for flow_framework.get

flow_framework->get_status

Retrieves the current workflow provisioning status.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/{workflow_id}/_status
$resp = $client->flow_framework->get_status(
    
     # path parameters
    
    'workflow_id'  =>  $workflow_id,  # required
    
     # Endpoint specific query string parameters
    
    'all'          =>  $qval1,     # boolean
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for flow_framework.get_status

flow_framework->get_steps

Retrieves available workflow steps.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/_steps
$resp = $client->flow_framework->get_steps(
    
     # Endpoint specific query string parameters
    
    'workflow_step'  =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'    =>  $qval2,     # boolean
    'filter_path'    =>  $qval3,     # list
    'human'          =>  $qval4,     # boolean
    'pretty'         =>  $qval5,     # boolean
    'source'         =>  $qval6,     # string
);

OpenSearch documentation for flow_framework.get_steps

flow_framework->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.

Paths served by this method:

POST /_plugins/_flow_framework/workflow/{workflow_id}/_provision
$resp = $client->flow_framework->provision(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'workflow_id'  =>  $workflow_id,  # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for flow_framework.provision

flow_framework->search

Search for workflows by using a query matching a field.

Paths served by this method:

POST /_plugins/_flow_framework/workflow/_search
$resp = $client->flow_framework->search(
    
    'body'         =>  $body,      # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for flow_framework.search

flow_framework->search_state

Search for workflows by using a query matching a field.

Paths served by this method:

POST /_plugins/_flow_framework/workflow/state/_search
$resp = $client->flow_framework->search_state(
    
    'body'         =>  $body,      # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for flow_framework.search_state

flow_framework->update

Updates a workflow template that has not been provisioned.

Paths served by this method:

PUT /_plugins/_flow_framework/workflow/{workflow_id}
$resp = $client->flow_framework->update(
    
    'body'           =>  $body,      # optional
    
     # path parameters
    
    'workflow_id'    =>  $workflow_id,  # required
    
     # Endpoint specific query string parameters
    
    'provision'      =>  $qval1,     # boolean
    'reprovision'    =>  $qval2,     # boolean
    'update_fields'  =>  $qval3,     # boolean
    'use_case'       =>  $qval4,     # string
    'validation'     =>  $qval5,     # string
    
     # Common API query string parameters
    
    'error_trace'    =>  $qval6,     # boolean
    'filter_path'    =>  $qval7,     # list
    'human'          =>  $qval8,     # boolean
    'pretty'         =>  $qval9,     # boolean
    'source'         =>  $qval10,    # string
);

OpenSearch documentation for flow_framework.update

MANUAL

Documentation index OpenSearch::Client::Manual

HISTORY

This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.

AUTHOR

Mark Dootson <mdootson@cpan.org> ( current maintainer )

CREDITS

OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.

COPYRIGHT AND LICENSE

Copyright (C) 2026 by Mark Dootson ( this distribution )

Copyright (C) 2021 by Elasticsearch BV ( original distribution )

This is free software, licensed under:

The Apache License, Version 2.0, January 2004