NAME

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

VERSION

version 3.007009

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

create

Creates a new workflow template.

Paths served by this method:

POST /_plugins/_flow_framework/workflow

Method added in OpenSearch version 2.12

$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

delete

Deletes a workflow template.

Paths served by this method:

DELETE /_plugins/_flow_framework/workflow/{workflow_id}

Method added in OpenSearch version 2.12

$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

deprovision

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

Paths served by this method:

POST /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision

Method added in OpenSearch version 2.12

$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

get

Retrieves a workflow template.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/{workflow_id}

Method added in OpenSearch version 2.12

$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

get_status

Retrieves the current workflow provisioning status.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/{workflow_id}/_status

Method added in OpenSearch version 2.12

$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

get_steps

Retrieves available workflow steps.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/_steps

Method added in OpenSearch version 2.12

$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

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

Method added in OpenSearch version 2.12

$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

search

Search for workflows by using a query matching a field.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/_search
POST /_plugins/_flow_framework/workflow/_search

Method added in OpenSearch version 2.12

$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

search_state

Search for workflows by using a query matching a field.

Paths served by this method:

GET /_plugins/_flow_framework/workflow/state/_search
POST /_plugins/_flow_framework/workflow/state/_search

Method added in OpenSearch version 2.12

$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

update

Updates a workflow template that has not been provisioned.

Paths served by this method:

PUT /_plugins/_flow_framework/workflow/{workflow_id}

Method added in OpenSearch version 2.12

$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

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->flow_framework->method_supported_in_version(
    method  => 'create',
    version => '2.4.0'
);

Both method and version are required.

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

To install OpenSearch::Client, copy and paste the appropriate command in to your terminal.

cpanm

cpanm OpenSearch::Client

CPAN shell

perl -MCPAN -e shell
install OpenSearch::Client

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

METHODS

create

delete

deprovision

get

get_status

get_steps

provision

search

search_state

update

method_supported_in_version

MANUAL

HISTORY

AUTHOR

CREDITS

COPYRIGHT AND LICENSE

Module Install Instructions

Keyboard Shortcuts