tapis_cli.commands.taccapis.v2.jobs package

Jobs service commands

Submodules

tapis_cli.commands.taccapis.v2.jobs.cancel module

class tapis_cli.commands.taccapis.v2.jobs.cancel.JobsCancel(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'Cancel a running or queued Job'
LEGACY_COMMMAND_STRING = 'jobs-stop'
VERBOSITY = 1
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.formatters module

Formatters customized for job records and listings

class tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatOne

class tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

class tapis_cli.commands.taccapis.v2.jobs.formatters.JobsHistoryFormatMany(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatManyUnlimited

class tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatManyUnlimited(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatManyUnlimited

tapis_cli.commands.taccapis.v2.jobs.hide module

class tapis_cli.commands.taccapis.v2.jobs.hide.JobsHide(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'Hide a Job from view'
LEGACY_COMMMAND_STRING = 'jobs-hide'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.history module

class tapis_cli.commands.taccapis.v2.jobs.history.JobsHistory(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsHistoryFormatMany, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'List history of a given job'
LEGACY_COMMMAND_STRING = 'jobs-history'
VERBOSITY = 1
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.list module

class tapis_cli.commands.taccapis.v2.jobs.list.JobsList(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany

EXTRA_VERBOSITY = 1
HELP_STRING = 'List Jobs'
LEGACY_COMMMAND_STRING = 'jobs-list'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.mixins module

class tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

Bases: tapis_cli.clients.services.mixins.TapisEntityUUID

Configures a Command to require a mandatory Tapis job UUID

dest = 'job_uuid'
service_id_type = 'Job'
validate_identifier(identifier, permissive=False)

tapis_cli.commands.taccapis.v2.jobs.outputs_download module

class tapis_cli.commands.taccapis.v2.jobs.outputs_download.JobsOutputsDownload(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID, tapis_cli.clients.services.mixins.RemoteFilePath, tapis_cli.commands.taccapis.v2.files.mixins.ExcludeFiles, tapis_cli.commands.taccapis.v2.files.mixins.IncludeFiles, tapis_cli.commands.taccapis.v2.files.mixins.OverwritePolicy, tapis_cli.commands.taccapis.v2.files.mixins.ReportProgress

HELP_STRING = 'Download outputs from a Job'
LEGACY_COMMMAND_STRING = 'jobs-output-get'
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.outputs_list module

class tapis_cli.commands.taccapis.v2.jobs.outputs_list.JobsOutputsList(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID, tapis_cli.commands.taccapis.v2.files.mixins.FilesOptions, tapis_cli.clients.services.mixins.RemoteFilePath

EXTRA_VERBOSITY = 2
HELP_STRING = 'Lists output directory for a Jobs'
LEGACY_COMMMAND_STRING = 'jobs-output-list'
VERBOSITY = 1
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.outputs_logs module

class tapis_cli.commands.taccapis.v2.jobs.outputs_logs.JobsOutputsLogs(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.files.formatters.FilesFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'Displays logs for a Tapis Job'
LEGACY_COMMMAND_STRING = None
VERBOSITY = 1
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.pems_drop module

class tapis_cli.commands.taccapis.v2.jobs.pems_drop.JobsPemsDrop(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'Drop all granted Permissions from a Job'
LEGACY_COMMMAND_STRING = 'jobs-pems-update'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.pems_grant module

class tapis_cli.commands.taccapis.v2.jobs.pems_grant.JobsPemsGrant(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2
HELP_STRING = 'Grant Permissions on a Job to a User'
LEGACY_COMMMAND_STRING = 'jobs-pems-update'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.pems_list module

class tapis_cli.commands.taccapis.v2.jobs.pems_list.JobsPemsList(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'List Permissions for a Job'
LEGACY_COMMMAND_STRING = 'jobs-pems-list'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.pems_revoke module

class tapis_cli.commands.taccapis.v2.jobs.pems_revoke.JobsPemsRevoke(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2
HELP_STRING = 'Revoke Permissions on a Job for a User'
LEGACY_COMMMAND_STRING = 'jobs-pems-update'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.pems_show module

class tapis_cli.commands.taccapis.v2.jobs.pems_show.JobsPemsShow(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2
HELP_STRING = 'Show Permissions on a Job for a User'
LEGACY_COMMMAND_STRING = 'jobs-pems-list'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.resubmit module

class tapis_cli.commands.taccapis.v2.jobs.resubmit.JobsResubmit(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'Resubmit a Job using the same inputs and parameters'
LEGACY_COMMMAND_STRING = 'jobs-resubmit'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.search module

class tapis_cli.commands.taccapis.v2.jobs.search.JobsSearch(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatMany

EXTRA_VERBOSITY = 1
HELP_STRING = 'Search Job records'
LEGACY_COMMMAND_STRING = 'jobs-search'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

tapis_cli.commands.taccapis.v2.jobs.show module

class tapis_cli.commands.taccapis.v2.jobs.show.JobsShow(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2.5
HELP_STRING = 'Show a specific Job'
LEGACY_COMMMAND_STRING = 'jobs-list'
VERBOSITY = 2
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.status module

class tapis_cli.commands.taccapis.v2.jobs.status.JobsStatus(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'how the status of a Job'
LEGACY_COMMMAND_STRING = 'jobs-status'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.submit module

class tapis_cli.commands.taccapis.v2.jobs.submit.JobsSubmit(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.clients.services.mixins.UploadJSONTemplate

EXTRA_VERBOSITY = 2
HELP_STRING = 'Submit a new Job'
LEGACY_COMMMAND_STRING = 'jobs-submit'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.

tapis_cli.commands.taccapis.v2.jobs.unhide module

class tapis_cli.commands.taccapis.v2.jobs.unhide.JobsUnhide(app, app_args, cmd_name=None)

Bases: tapis_cli.commands.taccapis.v2.jobs.formatters.JobsFormatOne, tapis_cli.commands.taccapis.v2.jobs.mixins.JobsUUID

EXTRA_VERBOSITY = 2
HELP_STRING = 'Unhide a hidden Job'
LEGACY_COMMMAND_STRING = 'jobs-unhide'
VERBOSITY = 0
get_parser(prog_name)

Return an argparse.ArgumentParser.

take_action(parsed_args)

Return a two-part tuple with a tuple of column names and a tuple of values.