tapis_cli.commands.taccapis.v2.metadata package¶

Metadata service commands

Subpackages¶

Submodules¶

tapis_cli.commands.taccapis.v2.metadata.create module¶

class tapis_cli.commands.taccapis.v2.metadata.create.MetadataCreate(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatOne, tapis_cli.commands.taccapis.v2.metadata.mixins.UploadMetadataFile

EXTRA_VERBOSITY = 2.5¶

HELP_STRING = 'Store Metadata in a new document'¶

LEGACY_COMMMAND_STRING = 'metadata-addupdate'¶

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.metadata.delete module¶

class tapis_cli.commands.taccapis.v2.metadata.delete.MetadataDelete(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatOne, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID

EXTRA_VERBOSITY = 2.5¶

HELP_STRING = 'Delete a Metadata document by UUID'¶

LEGACY_COMMMAND_STRING = 'metadata-delete'¶

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.metadata.formatters module¶

Formatters customized for metadata records and listings

class tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatOne(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatOne

class tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany(app, app_args, cmd_name=None)¶: Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataBase, tapis_cli.commands.taccapis.formatters.TaccApisFormatMany

tapis_cli.commands.taccapis.v2.metadata.list module¶

class tapis_cli.commands.taccapis.v2.metadata.list.MetadataList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List Metadata documents'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.mixins module¶

Metadata-specfic mixins

class tapis_cli.commands.taccapis.v2.metadata.mixins.UploadMetadataFile¶

Bases: tapis_cli.clients.services.mixins.UploadJSONTemplate

optional = True¶

class tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID¶

Bases: tapis_cli.clients.services.mixins.TapisEntityUUID

Configures a command to require a mandatory Tapis metadata UUID

dest = 'meta_uuid'¶

optional = False¶

service_id_type = 'Metadata'¶

suffix = '-012'¶

tapis_cli.commands.taccapis.v2.metadata.pems_drop module¶

class tapis_cli.commands.taccapis.v2.metadata.pems_drop.MetadataPemsDrop(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Drop all granted Permissions from a Metadata document'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.pems_grant module¶

class tapis_cli.commands.taccapis.v2.metadata.pems_grant.MetadataPemsGrant(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Grant Permissions on a Metadata document to a User'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.pems_list module¶

class tapis_cli.commands.taccapis.v2.metadata.pems_list.MetadataPemsList(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'List Permissions for a Metadata document'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.pems_revoke module¶

class tapis_cli.commands.taccapis.v2.metadata.pems_revoke.MetadataPemsRevoke(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Revoke Permissions on a Metadata document for a User'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.pems_show module¶

class tapis_cli.commands.taccapis.v2.metadata.pems_show.MetadataPemsShow(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatOne, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID, tapis_cli.clients.services.mixins.Username

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Show Permissions on a Metadata document for specific User'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.search module¶

class tapis_cli.commands.taccapis.v2.metadata.search.MetadataSearch(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatMany, tapis_cli.commands.taccapis.searchable.SearchableCommand

EXTRA_VERBOSITY = 2¶

HELP_STRING = 'Search for Metadata documents'¶

LEGACY_COMMMAND_STRING = 'metadata-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.

update_payload(parsed_args)¶

tapis_cli.commands.taccapis.v2.metadata.show module¶

class tapis_cli.commands.taccapis.v2.metadata.show.MetadataShow(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatOne, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID

EXTRA_VERBOSITY = 2.5¶

HELP_STRING = 'Show a Metadata document by UUID'¶

LEGACY_COMMMAND_STRING = 'metadata-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.metadata.update module¶

class tapis_cli.commands.taccapis.v2.metadata.update.MetadataUpdate(app, app_args, cmd_name=None)¶

Bases: tapis_cli.commands.taccapis.v2.metadata.formatters.MetadataFormatOne, tapis_cli.commands.taccapis.v2.metadata.mixins.UploadMetadataFile, tapis_cli.commands.taccapis.v2.metadata.mixins.MetadataUUID

EXTRA_VERBOSITY = 2.5¶

HELP_STRING = 'Update an existing Metadata document by UUID'¶

LEGACY_COMMMAND_STRING = 'metadata-addupdate'¶

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.