Search

Ingest

class gladier.tools.SearchIngest(*args, state_type: str = 'Action', state_name: str | None = None, comment: str | None = None, result_path: str | None = None, parameters: Dict[str, Any] | None = None, input_path: str | None = None, set_parameters_from_properties: bool = True, non_parameter_properties: Set[str] = {'_flow_definition', 'action_scope', 'action_url', 'comment', 'exception_handlers', 'exception_on_action_failure', 'input_path', 'next_state', 'non_parameter_properties', 'parameters', 'result_path', 'run_as', 'set_parameters_from_properties', 'state_name', 'state_type', 'wait_time'}, action_url: str = 'https://actions.globus.org/search/ingest', action_scope: str | None = None, wait_time: int = 600, exception_on_action_failure: bool = False, run_as: str | None = None, id: str | None = None, search_index: str = '$.input.search_index', subject: str = '$.input.subject', visible_to: list | str = '$.input.visible_to', content: dict | str = '$.input.content', **kwargs)

Bases: ActionState

Ingest a document into Globus Search

from gladier.tools import SearchIngest, SearchDelete

client = GladierClient(flow_definition=SearchIngest().get_flow_definition())

flow_run = client.run_flow(
    {"input": {
        "compute_endpoint": "4b116d3c-1703-4f8f-9f6f-39921e5864df",
        "content": {
            "contributors": [
                "John Smith",
                "FrobozzCo",
                "Zaphod Beeblebrox"
            ],
            "keywords": ["foo", "bar", "baz"],
            "title": "My Globus Tutorial Dataset"
        },
        "subject": subject,
        "search_index": '6a045ba6-68d7-41fa-9fae-17d0192fd859',
        "visible_to": ['public'],
    }}
)

Delete Subject

class gladier.tools.SearchDelete(*args, state_type: str = 'Action', state_name: str | None = None, comment: str | None = None, result_path: str | None = None, parameters: Dict[str, Any] | None = None, input_path: str | None = None, set_parameters_from_properties: bool = True, non_parameter_properties: Set[str] = {'_flow_definition', 'action_scope', 'action_url', 'comment', 'exception_handlers', 'exception_on_action_failure', 'input_path', 'next_state', 'non_parameter_properties', 'parameters', 'result_path', 'run_as', 'set_parameters_from_properties', 'state_name', 'state_type', 'wait_time'}, action_url: str = 'https://actions.globus.org/search/delete', action_scope: str | None = None, wait_time: int = 600, exception_on_action_failure: bool = False, run_as: str | None = None, search_index: str = '$.input.search_index', subject: str = '$.input.subject', delete_by: str = 'subject', **kwargs)

Bases: ActionState

Delete a single subject in Globus Search

from gladier.tools import SearchIngest, SearchDelete

client = GladierClient(flow_definition=SearchIngest().get_flow_definition())

flow_run = client.run_flow(
    {"input": {
        "subject": subject,
        "search_index": 'my-search-index-uuid',
        "visible_to": ['public'],
    }}
)

Delete Subject By Query

class gladier.tools.SearchDelete(*args, state_type: str = 'Action', state_name: str | None = None, comment: str | None = None, result_path: str | None = None, parameters: Dict[str, Any] | None = None, input_path: str | None = None, set_parameters_from_properties: bool = True, non_parameter_properties: Set[str] = {'_flow_definition', 'action_scope', 'action_url', 'comment', 'exception_handlers', 'exception_on_action_failure', 'input_path', 'next_state', 'non_parameter_properties', 'parameters', 'result_path', 'run_as', 'set_parameters_from_properties', 'state_name', 'state_type', 'wait_time'}, action_url: str = 'https://actions.globus.org/search/delete', action_scope: str | None = None, wait_time: int = 600, exception_on_action_failure: bool = False, run_as: str | None = None, search_index: str = '$.input.search_index', subject: str = '$.input.subject', delete_by: str = 'subject', **kwargs)

Bases: ActionState

Delete a single subject in Globus Search

from gladier.tools import SearchIngest, SearchDelete

client = GladierClient(flow_definition=SearchIngest().get_flow_definition())

flow_run = client.run_flow(
    {"input": {
        "subject": subject,
        "search_index": 'my-search-index-uuid',
        "visible_to": ['public'],
    }}
)