body_hash
stringlengths 64
64
| body
stringlengths 23
109k
| docstring
stringlengths 1
57k
| path
stringlengths 4
198
| name
stringlengths 1
115
| repository_name
stringlengths 7
111
| repository_stars
float64 0
191k
| lang
stringclasses 1
value | body_without_docstring
stringlengths 14
108k
| unified
stringlengths 45
133k
|
|---|---|---|---|---|---|---|---|---|---|
45bdaf105f1b8f3daabee340dfa853ae762c1da7addcd294774ea6ef38aac375
|
@click.command('clone', short_help='download any file using sharing link or file ID it will be automatically tracked henceforth')
@click.argument('payload')
def download(payload):
'\n clone: download a file/folder using either the sharing link or using the file ID for the file\n '
if (payload != None):
fid = utils.get_fid(payload)
else:
click.secho('argument error', fg='red')
with click.Context(download) as ctx:
click.echo(download.get_help(ctx))
sys.exit(0)
clone = utils.get_file(fid)
cwd = os.getcwd()
click.secho((("cloning into '" + clone['name']) + "' ....."), fg='magenta')
if (clone['mimeType'] == 'application/vnd.google-apps.folder'):
new_dir = os.path.join(cwd, clone['name'])
utils.create_new(new_dir, fid)
utils.pull_content(new_dir, fid)
else:
utils.file_download(clone, cwd)
click.secho((('cloning of ' + clone['name']) + ' completed'), fg='green')
|
clone: download a file/folder using either the sharing link or using the file ID for the file
|
drive_cli/actions.py
|
download
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('clone', short_help='download any file using sharing link or file ID it will be automatically tracked henceforth')
@click.argument('payload')
def download(payload):
'\n \n '
if (payload != None):
fid = utils.get_fid(payload)
else:
click.secho('argument error', fg='red')
with click.Context(download) as ctx:
click.echo(download.get_help(ctx))
sys.exit(0)
clone = utils.get_file(fid)
cwd = os.getcwd()
click.secho((("cloning into '" + clone['name']) + "' ....."), fg='magenta')
if (clone['mimeType'] == 'application/vnd.google-apps.folder'):
new_dir = os.path.join(cwd, clone['name'])
utils.create_new(new_dir, fid)
utils.pull_content(new_dir, fid)
else:
utils.file_download(clone, cwd)
click.secho((('cloning of ' + clone['name']) + ' completed'), fg='green')
|
@click.command('clone', short_help='download any file using sharing link or file ID it will be automatically tracked henceforth')
@click.argument('payload')
def download(payload):
'\n \n '
if (payload != None):
fid = utils.get_fid(payload)
else:
click.secho('argument error', fg='red')
with click.Context(download) as ctx:
click.echo(download.get_help(ctx))
sys.exit(0)
clone = utils.get_file(fid)
cwd = os.getcwd()
click.secho((("cloning into '" + clone['name']) + "' ....."), fg='magenta')
if (clone['mimeType'] == 'application/vnd.google-apps.folder'):
new_dir = os.path.join(cwd, clone['name'])
utils.create_new(new_dir, fid)
utils.pull_content(new_dir, fid)
else:
utils.file_download(clone, cwd)
click.secho((('cloning of ' + clone['name']) + ' completed'), fg='green')<|docstring|>clone: download a file/folder using either the sharing link or using the file ID for the file<|endoftext|>
|
c3c8b9c7bdeffd76e29b4e3e1245321e2ad2160722bf357b999a20a50b5b2d18
|
@click.command('add_remote', short_help='upload any existing file to drive')
@click.option('--file', help='specify the partcular file to uploaded else entire directory is uploaded')
@click.option('--pid', help='specify particular folder id/sharing_link of the folder under which remote must must be added')
def create_remote(file, pid):
'\n add_remote: create remote equivalent for existing file/folder in local device\n '
cwd = os.getcwd()
if (pid == None):
pid = 'root'
if (file != None):
file_path = os.path.join(cwd, file)
if os.path.isfile(file_path):
utils.upload_file(file, file_path, pid)
else:
click.secho(('No such file exist: ' + file_path), fg='red')
with click.Context(create_remote) as ctx:
click.echo(create_remote.get_help(ctx))
else:
sep = os.sep
(dir_cd, name) = (sep.join(cwd.split(sep)[:(- 1)]), cwd.split(sep)[(- 1)])
(child_cwd, child_id) = utils.create_dir(dir_cd, pid, name)
utils.push_content(child_cwd, child_id)
if (pid != None):
parent_file = utils.get_file(pid)
parent_name = parent_file['name']
click.secho(('content added under directory ' + parent_name), fg='magenta')
|
add_remote: create remote equivalent for existing file/folder in local device
|
drive_cli/actions.py
|
create_remote
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('add_remote', short_help='upload any existing file to drive')
@click.option('--file', help='specify the partcular file to uploaded else entire directory is uploaded')
@click.option('--pid', help='specify particular folder id/sharing_link of the folder under which remote must must be added')
def create_remote(file, pid):
'\n \n '
cwd = os.getcwd()
if (pid == None):
pid = 'root'
if (file != None):
file_path = os.path.join(cwd, file)
if os.path.isfile(file_path):
utils.upload_file(file, file_path, pid)
else:
click.secho(('No such file exist: ' + file_path), fg='red')
with click.Context(create_remote) as ctx:
click.echo(create_remote.get_help(ctx))
else:
sep = os.sep
(dir_cd, name) = (sep.join(cwd.split(sep)[:(- 1)]), cwd.split(sep)[(- 1)])
(child_cwd, child_id) = utils.create_dir(dir_cd, pid, name)
utils.push_content(child_cwd, child_id)
if (pid != None):
parent_file = utils.get_file(pid)
parent_name = parent_file['name']
click.secho(('content added under directory ' + parent_name), fg='magenta')
|
@click.command('add_remote', short_help='upload any existing file to drive')
@click.option('--file', help='specify the partcular file to uploaded else entire directory is uploaded')
@click.option('--pid', help='specify particular folder id/sharing_link of the folder under which remote must must be added')
def create_remote(file, pid):
'\n \n '
cwd = os.getcwd()
if (pid == None):
pid = 'root'
if (file != None):
file_path = os.path.join(cwd, file)
if os.path.isfile(file_path):
utils.upload_file(file, file_path, pid)
else:
click.secho(('No such file exist: ' + file_path), fg='red')
with click.Context(create_remote) as ctx:
click.echo(create_remote.get_help(ctx))
else:
sep = os.sep
(dir_cd, name) = (sep.join(cwd.split(sep)[:(- 1)]), cwd.split(sep)[(- 1)])
(child_cwd, child_id) = utils.create_dir(dir_cd, pid, name)
utils.push_content(child_cwd, child_id)
if (pid != None):
parent_file = utils.get_file(pid)
parent_name = parent_file['name']
click.secho(('content added under directory ' + parent_name), fg='magenta')<|docstring|>add_remote: create remote equivalent for existing file/folder in local device<|endoftext|>
|
d591ac73ef7fd401363cafd1bb2263ec486b60102a599cfbdaaccd4f6ca4c63d
|
@click.command('rm', short_help='delete a particular file in drive')
@click.option('--file', help='specify the partcular file to deleted else entire directory is deleted')
@click.option('--id', help='delete untracked file directly using id or sharing link, can be used even for unlinked files')
def delete(file, id):
'\n rm: delete a particular file/folder from the directory in the remote drive\n '
cwd = os.getcwd()
if (id == None):
if (file != None):
file_path = os.path.join(cwd, file)
if os.path.isfile(file_path):
local_dir = utils.get_child(cwd)
fid = local_dir[file]
else:
click.secho(('No such file exist: ' + file_path), fg='red')
with click.Context(delete) as ctx:
click.echo(delete.get_help(ctx))
cwd = file_path
else:
data = utils.drive_data()
fid = data[cwd]
data.pop(cwd, None)
utils.drive_data(data)
utils.delete_file(fid)
else:
fid = utils.get_fid(id)
utils.delete_file(fid)
|
rm: delete a particular file/folder from the directory in the remote drive
|
drive_cli/actions.py
|
delete
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('rm', short_help='delete a particular file in drive')
@click.option('--file', help='specify the partcular file to deleted else entire directory is deleted')
@click.option('--id', help='delete untracked file directly using id or sharing link, can be used even for unlinked files')
def delete(file, id):
'\n \n '
cwd = os.getcwd()
if (id == None):
if (file != None):
file_path = os.path.join(cwd, file)
if os.path.isfile(file_path):
local_dir = utils.get_child(cwd)
fid = local_dir[file]
else:
click.secho(('No such file exist: ' + file_path), fg='red')
with click.Context(delete) as ctx:
click.echo(delete.get_help(ctx))
cwd = file_path
else:
data = utils.drive_data()
fid = data[cwd]
data.pop(cwd, None)
utils.drive_data(data)
utils.delete_file(fid)
else:
fid = utils.get_fid(id)
utils.delete_file(fid)
|
@click.command('rm', short_help='delete a particular file in drive')
@click.option('--file', help='specify the partcular file to deleted else entire directory is deleted')
@click.option('--id', help='delete untracked file directly using id or sharing link, can be used even for unlinked files')
def delete(file, id):
'\n \n '
cwd = os.getcwd()
if (id == None):
if (file != None):
file_path = os.path.join(cwd, file)
if os.path.isfile(file_path):
local_dir = utils.get_child(cwd)
fid = local_dir[file]
else:
click.secho(('No such file exist: ' + file_path), fg='red')
with click.Context(delete) as ctx:
click.echo(delete.get_help(ctx))
cwd = file_path
else:
data = utils.drive_data()
fid = data[cwd]
data.pop(cwd, None)
utils.drive_data(data)
utils.delete_file(fid)
else:
fid = utils.get_fid(id)
utils.delete_file(fid)<|docstring|>rm: delete a particular file/folder from the directory in the remote drive<|endoftext|>
|
668d0904d4aa4547243a6a6dcfda0ba92df0b42f7203e9a8f23363ce713acf38
|
@click.command('ls', short_help='list out all the files present in this directory in the drive for tracked directories')
def list_out():
'\n ls: Print files belonging to a folder in the drive folder of the current directory\n '
data = utils.drive_data()
token = os.path.join(dirpath, 'token.json')
store = file.Storage(token)
creds = store.get()
service = build('drive', 'v3', http=creds.authorize(Http()))
page_token = None
cwd = os.getcwd()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone', fg='red')
sys.exit(0)
query = (("'" + data[cwd]['id']) + "' in parents")
click.secho('listing down files in drive ....', fg='magenta')
t = PrettyTable(['Name', 'File ID', 'Type'])
while True:
children = service.files().list(q=query, spaces='drive', fields='nextPageToken, files(id,mimeType,name)', pageToken=page_token).execute()
for child in children.get('files', []):
t.add_row([child.get('name')[:25], child.get('id'), child.get('mimeType')])
page_token = children.get('nextPageToken', None)
if (page_token is None):
break
print(t)
|
ls: Print files belonging to a folder in the drive folder of the current directory
|
drive_cli/actions.py
|
list_out
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('ls', short_help='list out all the files present in this directory in the drive for tracked directories')
def list_out():
'\n \n '
data = utils.drive_data()
token = os.path.join(dirpath, 'token.json')
store = file.Storage(token)
creds = store.get()
service = build('drive', 'v3', http=creds.authorize(Http()))
page_token = None
cwd = os.getcwd()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone', fg='red')
sys.exit(0)
query = (("'" + data[cwd]['id']) + "' in parents")
click.secho('listing down files in drive ....', fg='magenta')
t = PrettyTable(['Name', 'File ID', 'Type'])
while True:
children = service.files().list(q=query, spaces='drive', fields='nextPageToken, files(id,mimeType,name)', pageToken=page_token).execute()
for child in children.get('files', []):
t.add_row([child.get('name')[:25], child.get('id'), child.get('mimeType')])
page_token = children.get('nextPageToken', None)
if (page_token is None):
break
print(t)
|
@click.command('ls', short_help='list out all the files present in this directory in the drive for tracked directories')
def list_out():
'\n \n '
data = utils.drive_data()
token = os.path.join(dirpath, 'token.json')
store = file.Storage(token)
creds = store.get()
service = build('drive', 'v3', http=creds.authorize(Http()))
page_token = None
cwd = os.getcwd()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone', fg='red')
sys.exit(0)
query = (("'" + data[cwd]['id']) + "' in parents")
click.secho('listing down files in drive ....', fg='magenta')
t = PrettyTable(['Name', 'File ID', 'Type'])
while True:
children = service.files().list(q=query, spaces='drive', fields='nextPageToken, files(id,mimeType,name)', pageToken=page_token).execute()
for child in children.get('files', []):
t.add_row([child.get('name')[:25], child.get('id'), child.get('mimeType')])
page_token = children.get('nextPageToken', None)
if (page_token is None):
break
print(t)<|docstring|>ls: Print files belonging to a folder in the drive folder of the current directory<|endoftext|>
|
20aa4254477ae62e3bf14821492f3e08efcc37070fae002a5804c2732914b4fb
|
@click.command('status', short_help='list changes committed since last sync')
def status():
'\n status: get a change log of files changed since you had the last sync(push/pull/clone)\n '
cwd = os.getcwd()
data = utils.drive_data()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone ', fg='red')
sys.exit(0)
sync_time = data[cwd]['time']
utils.list_status(cwd, sync_time)
|
status: get a change log of files changed since you had the last sync(push/pull/clone)
|
drive_cli/actions.py
|
status
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('status', short_help='list changes committed since last sync')
def status():
'\n \n '
cwd = os.getcwd()
data = utils.drive_data()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone ', fg='red')
sys.exit(0)
sync_time = data[cwd]['time']
utils.list_status(cwd, sync_time)
|
@click.command('status', short_help='list changes committed since last sync')
def status():
'\n \n '
cwd = os.getcwd()
data = utils.drive_data()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone ', fg='red')
sys.exit(0)
sync_time = data[cwd]['time']
utils.list_status(cwd, sync_time)<|docstring|>status: get a change log of files changed since you had the last sync(push/pull/clone)<|endoftext|>
|
0a69e940cfed6199c493a0898d0f1e684bb5c2eea60b3dd7613ff1d879da4889
|
@click.command('push', short_help='push modification from local files to the drive')
def push():
'\n push the latest changes from your local folder that has been added/cloned to google drive.\n '
data = utils.drive_data()
cwd = os.getcwd()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone ', fg='red')
sys.exit(0)
fid = data[cwd]['id']
current_root = utils.get_file(fid)
click.secho((("checking for changes in '" + current_root['name']) + "' ...."), fg='magenta')
utils.push_content(cwd, fid)
click.secho('Working directory is clean', fg='green')
|
push the latest changes from your local folder that has been added/cloned to google drive.
|
drive_cli/actions.py
|
push
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('push', short_help='push modification from local files to the drive')
def push():
'\n \n '
data = utils.drive_data()
cwd = os.getcwd()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone ', fg='red')
sys.exit(0)
fid = data[cwd]['id']
current_root = utils.get_file(fid)
click.secho((("checking for changes in '" + current_root['name']) + "' ...."), fg='magenta')
utils.push_content(cwd, fid)
click.secho('Working directory is clean', fg='green')
|
@click.command('push', short_help='push modification from local files to the drive')
def push():
'\n \n '
data = utils.drive_data()
cwd = os.getcwd()
if (cwd not in data.keys()):
click.secho('following directory has not been tracked: \nuse drive add_remote or drive clone ', fg='red')
sys.exit(0)
fid = data[cwd]['id']
current_root = utils.get_file(fid)
click.secho((("checking for changes in '" + current_root['name']) + "' ...."), fg='magenta')
utils.push_content(cwd, fid)
click.secho('Working directory is clean', fg='green')<|docstring|>push the latest changes from your local folder that has been added/cloned to google drive.<|endoftext|>
|
465b22bc9bd2b99965dcbaafb91e07f5180e691d5ca1b8da20d9a6c9d33a49b7
|
@click.command('share', short_help='share file using file id or link')
@click.argument('fid')
@click.option('--role', default='reader', help=role_help)
@click.option('--type', default='user', help=type_help)
@click.option('--message', default='shared via drive-cli', help=message_help)
def share(fid, role, type, message):
'\n share file/folder using using either the sharing link or using the file ID\n '
click.secho('updating share setting.....', fg='magenta')
file_id = utils.get_fid(fid)
token = os.path.join(dirpath, 'token.json')
store = file.Storage(token)
creds = store.get()
service = build('drive', 'v3', http=creds.authorize(Http()))
if (type == 'anyone'):
if (role == 'owner'):
transfer_ownership = True
else:
transfer_ownership = False
request = {'role': role, 'type': type, 'allowFileDiscovery': True}
try:
response = service.permissions().create(body=request, fileId=file_id, transferOwnership=transfer_ownership, fields='id').execute()
if (list(response.keys())[0] == 'error'):
click.secho(response['error']['message'], fg='red')
else:
share_link = ('https://drive.google.com/open?id=' + file_id)
click.secho(('share link : ' + share_link))
except:
error_message = str(sys.exc_info()[1])
error_message = error_message.split('"')[1]
click.secho(error_message, fg='red')
else:
if (type == 'user'):
email_id = click.prompt('Enetr email address of user ')
else:
email_id = click.prompt('Enetr email address of a google group ')
if (role == 'owner'):
transfer_ownership = True
else:
transfer_ownership = False
request = {'role': role, 'type': type, 'emailAddress': email_id}
try:
response = service.permissions().create(body=request, fileId=file_id, emailMessage=message, sendNotificationEmail=True, transferOwnership=transfer_ownership, fields='id').execute()
if (list(response.keys())[0] == 'error'):
click.secho(response['error']['message'], fg='red')
else:
click.secho('successfully share', fg='green')
except:
error_message = str(sys.exc_info()[1])
error_message = error_message.split('"')[1]
click.secho(error_message, fg='red')
|
share file/folder using using either the sharing link or using the file ID
|
drive_cli/actions.py
|
share
|
ahegde3/drive-cli
| 0 |
python
|
@click.command('share', short_help='share file using file id or link')
@click.argument('fid')
@click.option('--role', default='reader', help=role_help)
@click.option('--type', default='user', help=type_help)
@click.option('--message', default='shared via drive-cli', help=message_help)
def share(fid, role, type, message):
'\n \n '
click.secho('updating share setting.....', fg='magenta')
file_id = utils.get_fid(fid)
token = os.path.join(dirpath, 'token.json')
store = file.Storage(token)
creds = store.get()
service = build('drive', 'v3', http=creds.authorize(Http()))
if (type == 'anyone'):
if (role == 'owner'):
transfer_ownership = True
else:
transfer_ownership = False
request = {'role': role, 'type': type, 'allowFileDiscovery': True}
try:
response = service.permissions().create(body=request, fileId=file_id, transferOwnership=transfer_ownership, fields='id').execute()
if (list(response.keys())[0] == 'error'):
click.secho(response['error']['message'], fg='red')
else:
share_link = ('https://drive.google.com/open?id=' + file_id)
click.secho(('share link : ' + share_link))
except:
error_message = str(sys.exc_info()[1])
error_message = error_message.split('"')[1]
click.secho(error_message, fg='red')
else:
if (type == 'user'):
email_id = click.prompt('Enetr email address of user ')
else:
email_id = click.prompt('Enetr email address of a google group ')
if (role == 'owner'):
transfer_ownership = True
else:
transfer_ownership = False
request = {'role': role, 'type': type, 'emailAddress': email_id}
try:
response = service.permissions().create(body=request, fileId=file_id, emailMessage=message, sendNotificationEmail=True, transferOwnership=transfer_ownership, fields='id').execute()
if (list(response.keys())[0] == 'error'):
click.secho(response['error']['message'], fg='red')
else:
click.secho('successfully share', fg='green')
except:
error_message = str(sys.exc_info()[1])
error_message = error_message.split('"')[1]
click.secho(error_message, fg='red')
|
@click.command('share', short_help='share file using file id or link')
@click.argument('fid')
@click.option('--role', default='reader', help=role_help)
@click.option('--type', default='user', help=type_help)
@click.option('--message', default='shared via drive-cli', help=message_help)
def share(fid, role, type, message):
'\n \n '
click.secho('updating share setting.....', fg='magenta')
file_id = utils.get_fid(fid)
token = os.path.join(dirpath, 'token.json')
store = file.Storage(token)
creds = store.get()
service = build('drive', 'v3', http=creds.authorize(Http()))
if (type == 'anyone'):
if (role == 'owner'):
transfer_ownership = True
else:
transfer_ownership = False
request = {'role': role, 'type': type, 'allowFileDiscovery': True}
try:
response = service.permissions().create(body=request, fileId=file_id, transferOwnership=transfer_ownership, fields='id').execute()
if (list(response.keys())[0] == 'error'):
click.secho(response['error']['message'], fg='red')
else:
share_link = ('https://drive.google.com/open?id=' + file_id)
click.secho(('share link : ' + share_link))
except:
error_message = str(sys.exc_info()[1])
error_message = error_message.split('"')[1]
click.secho(error_message, fg='red')
else:
if (type == 'user'):
email_id = click.prompt('Enetr email address of user ')
else:
email_id = click.prompt('Enetr email address of a google group ')
if (role == 'owner'):
transfer_ownership = True
else:
transfer_ownership = False
request = {'role': role, 'type': type, 'emailAddress': email_id}
try:
response = service.permissions().create(body=request, fileId=file_id, emailMessage=message, sendNotificationEmail=True, transferOwnership=transfer_ownership, fields='id').execute()
if (list(response.keys())[0] == 'error'):
click.secho(response['error']['message'], fg='red')
else:
click.secho('successfully share', fg='green')
except:
error_message = str(sys.exc_info()[1])
error_message = error_message.split('"')[1]
click.secho(error_message, fg='red')<|docstring|>share file/folder using using either the sharing link or using the file ID<|endoftext|>
|
bf3efb8522b509c74facf7f98b359e4a5230b141cc851622e9696bb9de69a6ee
|
def files_children(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children(file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_with_http_info(**kwargs)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children(file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children(file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_with_http_info(**kwargs)
|
def files_children(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children(file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children(file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
fdecedcee623fd480b2623ea82f094b6f9ba5f46c567e28e4803e911a652c026
|
def files_children_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_with_http_info(file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children`')
collection_formats = {}
path_params = {}
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_with_http_info(file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_with_http_info(file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children`')
collection_formats = {}
path_params = {}
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def files_children_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_with_http_info(file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children`')
collection_formats = {}
path_params = {}
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_with_http_info(file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
442e285eebe75a40d613f05be435146383d24692b787c05239101aa476e56381
|
def files_children_by_container(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_container(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_container_with_http_info(**kwargs)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_container(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_container
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_container(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_container(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_container_with_http_info(**kwargs)
|
def files_children_by_container(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_container(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_container_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_container(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
5a2810c3575a1e87284b54b4ea5919de25dece9c3974cd0c7a2e9add05a0981a
|
def files_children_by_container_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_container_with_http_info(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `files_children_by_container`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_container_with_http_info(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_container_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_container_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_container_with_http_info(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `files_children_by_container`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def files_children_by_container_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_container_with_http_info(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `files_children_by_container`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_container_with_http_info(container_id=container_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
8dd9c50b671a3676765423ceb3253e50551ab0356a50b9e8f934aefe6e4e25af
|
def files_children_by_pool(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_pool_with_http_info(**kwargs)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_pool(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_pool_with_http_info(**kwargs)
|
def files_children_by_pool(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_pool_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
725539057f641a7123eaa23d2974bd3ba11f52fde4f26509eca7e4f5cd814c7c
|
def files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
c02ebe3e7df73f2a53da4675f552dfa394887f0ef51d830ddc9e71dc40a1fcba
|
def files_children_by_task(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_with_http_info(**kwargs)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_task(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_with_http_info(**kwargs)
|
def files_children_by_task(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
eabd13bf0aee747a5789470d19f509247f3ad41644af4477a6c3c9df4d3c93fb
|
def files_children_by_task_with_http_info(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_with_http_info(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `files_children_by_task`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_with_http_info(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_task_with_http_info(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_with_http_info(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `files_children_by_task`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def files_children_by_task_with_http_info(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_with_http_info(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `files_children_by_task`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_with_http_info(task_id=task_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
c6c8e78c53b99c4ecc458722d7929390058de3ff94e10fc7bf734f579f9a3acd
|
def files_children_by_task_execution(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_execution_with_http_info(**kwargs)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_task_execution
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_task_execution(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_execution_with_http_info(**kwargs)
|
def files_children_by_task_execution(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_execution_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
cf594249a7a8f034dd45c0b7e9c858a424778a8949724dc95474ad8c63ed228d
|
def files_children_by_task_execution_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `files_children_by_task_execution`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_task_execution_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_task_execution_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `files_children_by_task_execution`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def files_children_by_task_execution_with_http_info(self, **kwargs):
'Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `files_children_by_task_execution`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
b77e3e3e20e007c982091ae8279cf73b9326d072b99c9bb729058cd9ab1e8b68
|
def files_children_by_task_execution_by_task(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_execution_by_task_with_http_info(**kwargs)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_task_execution_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_task_execution_by_task(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_execution_by_task_with_http_info(**kwargs)
|
def files_children_by_task_execution_by_task(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.files_children_by_task_execution_by_task_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
9570225dd943688f400e57e90a2b35bf48ad1f5adcf4e6a55bc85b2c0da64601
|
def files_children_by_task_execution_by_task_with_http_info(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `files_children_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `files_children_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
files_children_by_task_execution_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def files_children_by_task_execution_by_task_with_http_info(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `files_children_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `files_children_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def files_children_by_task_execution_by_task_with_http_info(self, **kwargs):
"Lists files under a specific folder. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.files_children_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method files_children_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `files_children_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `files_children_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `files_children_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.files_children_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
7cbc95b2365be05ad90ea3d80cbad86c88941ef39fbf1e9685f63a48c664b7e4
|
def import_files_children_by_pool(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.import_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.import_files_children_by_pool_with_http_info(**kwargs)
|
Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.import_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImportFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
import_files_children_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def import_files_children_by_pool(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.import_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.import_files_children_by_pool_with_http_info(**kwargs)
|
def import_files_children_by_pool(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.import_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.import_files_children_by_pool_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.import_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImportFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
4b978d66ce40457d2abda2041aa5bdc7b46473273692fc114e399c65fec3fc28
|
def import_files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.import_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method import_files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `import_files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `import_files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.import_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
import_files_children_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def import_files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.import_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method import_files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `import_files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `import_files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def import_files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.import_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method import_files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `import_files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `import_files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.import_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
7e90b26a91a40a79868be81361fda9ce011e1304b0a03349aab2d0f91a577824
|
def index_files(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files(async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_with_http_info(**kwargs)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files(async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_with_http_info(**kwargs)
|
def index_files(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files(async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_with_http_info(**kwargs)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
b0aaee65e49d943ee2aecf17588a01f1a6a816b8f515c638872b4c31e67ca3d6
|
def index_files_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_with_http_info(async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files" % key))
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_with_http_info(async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files" % key))
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_files_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_with_http_info(async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files" % key))
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
aa7000c4bc910f0d158abc0a3a6bd20d72f0a7c199c3cb82cb28e72010578fed
|
def index_files_by_container(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_container(container_id=container_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_container_with_http_info(**kwargs)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_container(container_id=container_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_container
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_container(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_container(container_id=container_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_container_with_http_info(**kwargs)
|
def index_files_by_container(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_container(container_id=container_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_container_with_http_info(**kwargs)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_container(container_id=container_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
36247806de6859a59331585102fe8e4682afae14dbb83b5b87f2f30367d045e0
|
def index_files_by_container_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_container_with_http_info(container_id=container_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `index_files_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_container_with_http_info(container_id=container_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_container_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_container_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_container_with_http_info(container_id=container_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `index_files_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_files_by_container_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_container_with_http_info(container_id=container_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `index_files_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_container_with_http_info(container_id=container_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
122062d00c021892b5ce6dd12e3c8744d6abbcc2e8cc205e3461433d0c450904
|
def index_files_by_pool(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_pool_with_http_info(**kwargs)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_pool(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_pool(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_pool_with_http_info(**kwargs)
|
def index_files_by_pool(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_pool_with_http_info(**kwargs)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_pool(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
8db190944456c06083e3fcd0ff08256880934f5a8ee1b584c36a3935d0e6e526
|
def index_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
22e1a2e9941331c1e4d4ffc5baaf8ffdca21a3458679454575dddc31fb05a0c3
|
def index_files_by_task(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task(task_id=task_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_with_http_info(**kwargs)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task(task_id=task_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_task(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task(task_id=task_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_with_http_info(**kwargs)
|
def index_files_by_task(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task(task_id=task_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_with_http_info(**kwargs)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task(task_id=task_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
50b1bb169caa6a3eb283cde64a8ceadb0c446d7f427a9ecb9b95ba5c1fb7804b
|
def index_files_by_task_with_http_info(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_with_http_info(task_id=task_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_files_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_with_http_info(task_id=task_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_task_with_http_info(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_with_http_info(task_id=task_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_files_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_files_by_task_with_http_info(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_with_http_info(task_id=task_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_files_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_with_http_info(task_id=task_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
71b323dca7809028f8a04441daf484acac0b5991179953e65e1b9110270e24ae
|
def index_files_by_task_execution(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution(task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_execution_with_http_info(**kwargs)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution(task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_task_execution
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_task_execution(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution(task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_execution_with_http_info(**kwargs)
|
def index_files_by_task_execution(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution(task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_execution_with_http_info(**kwargs)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution(task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
621cb446aeceb621aca927ab2372c7972a878eba170791950fad46b4cd14bb4e
|
def index_files_by_task_execution_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_files_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_task_execution_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_task_execution_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_files_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_files_by_task_execution_with_http_info(self, **kwargs):
'Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_files_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
20b2c552f54a858f32687741ec0178da1bd604cf60a5bb340bb92354550febf0
|
def index_files_by_task_execution_by_task(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_execution_by_task_with_http_info(**kwargs)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_task_execution_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_task_execution_by_task(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_execution_by_task_with_http_info(**kwargs)
|
def index_files_by_task_execution_by_task(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_files_by_task_execution_by_task_with_http_info(**kwargs)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
0a24ffb16be925f865c2232ecd7fac53ea26ac42db6976917bae663493f08974
|
def index_files_by_task_execution_by_task_with_http_info(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_files_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_files_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_files_by_task_execution_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_files_by_task_execution_by_task_with_http_info(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_files_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_files_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_files_by_task_execution_by_task_with_http_info(self, **kwargs):
"Lists files on root. # noqa: E501\n\n **API Key Scope**: files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_files_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_files_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_files_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_files_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root. # noqa: E501
**API Key Scope**: files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_files_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
24de446b16fe99af334a5f2e4a2547e530ec019ab1642fd2e93f71f8d0751441
|
def index_import_files_by_pool(self, **kwargs):
'Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_import_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_import_files_by_pool_with_http_info(**kwargs)
|
Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_import_files_by_pool(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImportFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_import_files_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_import_files_by_pool(self, **kwargs):
'Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_import_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_import_files_by_pool_with_http_info(**kwargs)
|
def index_import_files_by_pool(self, **kwargs):
'Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_import_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_import_files_by_pool_with_http_info(**kwargs)<|docstring|>Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_import_files_by_pool(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImportFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
95c8a428c22a341060f5425d5a06e212e0a96582b42cc60d5279496a0964bcae
|
def index_import_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_import_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_import_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_import_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_import_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_import_files_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_import_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_import_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_import_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_import_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_import_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_import_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str file_id: Filter on file id\n :param str name: Filter on name\n :param str type: Filter on type\n :param str permission: Filter on permission\n :param str size: Filter on size\n :param str change_date: Filter on change date\n :param str modification_date: Filter on modification date\n :param str access_date: Filter on access date\n :param str gid: Filter on gid\n :param str uid: Filter on uid\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'file_id', 'name', 'type', 'permission', 'size', 'change_date', 'modification_date', 'access_date', 'gid', 'uid']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_import_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_import_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('file_id' in local_var_params) and (local_var_params['file_id'] is not None)):
query_params.append(('file_id', local_var_params['file_id']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('permission' in local_var_params) and (local_var_params['permission'] is not None)):
query_params.append(('permission', local_var_params['permission']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
if (('change_date' in local_var_params) and (local_var_params['change_date'] is not None)):
query_params.append(('change_date', local_var_params['change_date']))
if (('modification_date' in local_var_params) and (local_var_params['modification_date'] is not None)):
query_params.append(('modification_date', local_var_params['modification_date']))
if (('access_date' in local_var_params) and (local_var_params['access_date'] is not None)):
query_params.append(('access_date', local_var_params['access_date']))
if (('gid' in local_var_params) and (local_var_params['gid'] is not None)):
query_params.append(('gid', local_var_params['gid']))
if (('uid' in local_var_params) and (local_var_params['uid'] is not None)):
query_params.append(('uid', local_var_params['uid']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root of tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_import_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str file_id: Filter on file id
:param str name: Filter on name
:param str type: Filter on type
:param str permission: Filter on permission
:param str size: Filter on size
:param str change_date: Filter on change date
:param str modification_date: Filter on modification date
:param str access_date: Filter on access date
:param str gid: Filter on gid
:param str uid: Filter on uid
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImportFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
641edc2d4f95b3124265c7027e183bbd10a46add5ba0a3630be6a27b2b7153cc
|
def index_on_tapes_files_by_pool(self, **kwargs):
'Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_on_tapes_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_on_tapes_files_by_pool_with_http_info(**kwargs)
|
Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_on_tapes_files_by_pool(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OnTapesFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_on_tapes_files_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_on_tapes_files_by_pool(self, **kwargs):
'Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_on_tapes_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_on_tapes_files_by_pool_with_http_info(**kwargs)
|
def index_on_tapes_files_by_pool(self, **kwargs):
'Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_on_tapes_files_by_pool(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_on_tapes_files_by_pool_with_http_info(**kwargs)<|docstring|>Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_on_tapes_files_by_pool(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OnTapesFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
57cb380229b0f8b579d79ee460530c80aecb203d7ec6f1bc2a6fefa812af3f42
|
def index_on_tapes_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_on_tapes_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'name', 'type', 'size']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_on_tapes_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_on_tapes_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_on_tapes_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_on_tapes_files_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_on_tapes_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_on_tapes_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'name', 'type', 'size']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_on_tapes_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_on_tapes_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_on_tapes_files_by_pool_with_http_info(self, **kwargs):
'Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_on_tapes_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'limit', 'offset', 'name', 'type', 'size']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_on_tapes_files_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_on_tapes_files_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files on root of tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_on_tapes_files_by_pool_with_http_info(pool_id=pool_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
5787784ae08ccfcb8a9c4586b21973d936da88b6d594132543da3cecba593c34
|
def index_tapes_by_file_by_pool(self, **kwargs):
'Displays tapes containing specific file, related to the specific pool. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_pool_with_http_info(**kwargs)
|
Displays tapes containing specific file, related to the specific pool. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_pool(self, **kwargs):
'Displays tapes containing specific file, related to the specific pool. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_pool_with_http_info(**kwargs)
|
def index_tapes_by_file_by_pool(self, **kwargs):
'Displays tapes containing specific file, related to the specific pool. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_pool_with_http_info(**kwargs)<|docstring|>Displays tapes containing specific file, related to the specific pool. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
79d237bf368b76ac358f67b918ffafbfda67125c9db15dca1f6b32842e213dbc
|
def index_tapes_by_file_by_pool_with_http_info(self, **kwargs):
'Displays tapes containing specific file, related to the specific pool. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_tapes_by_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays tapes containing specific file, related to the specific pool. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_pool_with_http_info(self, **kwargs):
'Displays tapes containing specific file, related to the specific pool. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_tapes_by_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_tapes_by_file_by_pool_with_http_info(self, **kwargs):
'Displays tapes containing specific file, related to the specific pool. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `index_tapes_by_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays tapes containing specific file, related to the specific pool. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
9c61d33ad650eb2731429f01598a7b799c66c3d779bbb3eba981db22ed3b3318
|
def index_tapes_by_file_by_task(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_with_http_info(**kwargs)
|
Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_task(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_with_http_info(**kwargs)
|
def index_tapes_by_file_by_task(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_with_http_info(**kwargs)<|docstring|>Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
c482e35ca21d843a39452dc700a1a6c42676e00661df86f7409ac55c05625066
|
def index_tapes_by_file_by_task_with_http_info(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_tapes_by_file_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_task_with_http_info(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_tapes_by_file_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_tapes_by_file_by_task_with_http_info(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_tapes_by_file_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
caddbc0da28cdeafa4f96066a8d57862429b3df3f704a83820c1a85e6447bae3
|
def index_tapes_by_file_by_task_execution(self, **kwargs):
'Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_execution_with_http_info(**kwargs)
|
Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_task_execution
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_task_execution(self, **kwargs):
'Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_execution_with_http_info(**kwargs)
|
def index_tapes_by_file_by_task_execution(self, **kwargs):
'Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_execution_with_http_info(**kwargs)<|docstring|>Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
7d27b9a105fa4bf90b57fab79e83100f88fd091039b29d6d1093e21d61a9ad71
|
def index_tapes_by_file_by_task_execution_with_http_info(self, **kwargs):
'Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_tapes_by_file_by_task_execution`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_task_execution_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_task_execution_with_http_info(self, **kwargs):
'Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_tapes_by_file_by_task_execution`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_tapes_by_file_by_task_execution_with_http_info(self, **kwargs):
'Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_tapes_by_file_by_task_execution`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
f983404fe5746f416f8beb7398e0efcff85d196cef9bb3cf97a8d2bcde0a533f
|
def index_tapes_by_file_by_task_execution_by_task(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_execution_by_task_with_http_info(**kwargs)
|
Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_task_execution_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_task_execution_by_task(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_execution_by_task_with_http_info(**kwargs)
|
def index_tapes_by_file_by_task_execution_by_task(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: TapeCollection\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.index_tapes_by_file_by_task_execution_by_task_with_http_info(**kwargs)<|docstring|>Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: TapeCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
b36a2eb88dd2e94feb7a3baf84e481ff99bdca68d93eacc5ea1a30c468f61257
|
def index_tapes_by_file_by_task_execution_by_task_with_http_info(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
index_tapes_by_file_by_task_execution_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def index_tapes_by_file_by_task_execution_by_task_with_http_info(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def index_tapes_by_file_by_task_execution_by_task_with_http_info(self, **kwargs):
"Displays tapes containing specific file, related to the specific task. # noqa: E501\n\n **API Key Scope**: files / tapes # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method index_tapes_by_file_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `index_tapes_by_file_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}/tapes', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='TapeCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays tapes containing specific file, related to the specific task. # noqa: E501
**API Key Scope**: files / tapes # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.index_tapes_by_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(TapeCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
630575d37b4178343c2e94d60a5ff6e224c24920c1d96458cf23fa3208704134
|
def on_tapes_files_children_by_pool(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.on_tapes_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.on_tapes_files_children_by_pool_with_http_info(**kwargs)
|
Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.on_tapes_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OnTapesFileCollection
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
on_tapes_files_children_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def on_tapes_files_children_by_pool(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.on_tapes_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.on_tapes_files_children_by_pool_with_http_info(**kwargs)
|
def on_tapes_files_children_by_pool(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.on_tapes_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFileCollection\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.on_tapes_files_children_by_pool_with_http_info(**kwargs)<|docstring|>Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.on_tapes_files_children_by_pool(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OnTapesFileCollection
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
f4676fc026e08ff0685209d6f0ab55ca18af9499d051115980152420a8ec2d75
|
def on_tapes_files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.on_tapes_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'name', 'type', 'size']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method on_tapes_files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `on_tapes_files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `on_tapes_files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.on_tapes_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
on_tapes_files_children_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def on_tapes_files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.on_tapes_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'name', 'type', 'size']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method on_tapes_files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `on_tapes_files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `on_tapes_files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def on_tapes_files_children_by_pool_with_http_info(self, **kwargs):
'Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / index # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.on_tapes_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_parent_id: Numeric ID of parent folder. (required)\n :param int limit: The number of items to display for pagination.\n :param int offset: The number of items to skip for pagination.\n :param str name: Filter on name\n :param str type: Filter on type\n :param str size: Filter on size\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_parent_id', 'limit', 'offset', 'name', 'type', 'size']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method on_tapes_files_children_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `on_tapes_files_children_by_pool`')
if (self.api_client.client_side_validation and (('file_parent_id' not in local_var_params) or (local_var_params['file_parent_id'] is None))):
raise ApiValueError('Missing the required parameter `file_parent_id` when calling `on_tapes_files_children_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_parent_id' in local_var_params):
path_params['file_parent_id'] = local_var_params['file_parent_id']
query_params = []
if (('limit' in local_var_params) and (local_var_params['limit'] is not None)):
query_params.append(('limit', local_var_params['limit']))
if (('offset' in local_var_params) and (local_var_params['offset'] is not None)):
query_params.append(('offset', local_var_params['offset']))
if (('name' in local_var_params) and (local_var_params['name'] is not None)):
query_params.append(('name', local_var_params['name']))
if (('type' in local_var_params) and (local_var_params['type'] is not None)):
query_params.append(('type', local_var_params['type']))
if (('size' in local_var_params) and (local_var_params['size'] is not None)):
query_params.append(('size', local_var_params['size']))
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files/{file_parent_id}/children', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFileCollection', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Lists files under a specific folder on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / index # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.on_tapes_files_children_by_pool_with_http_info(pool_id=pool_id_value, file_parent_id=file_parent_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_parent_id: Numeric ID of parent folder. (required)
:param int limit: The number of items to display for pagination.
:param int offset: The number of items to skip for pagination.
:param str name: Filter on name
:param str type: Filter on type
:param str size: Filter on size
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OnTapesFileCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
f0486151150e4d67845c59fe38ccc9cae01a4e58c3224d83abb1c9113f44856a
|
def show_file(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file(file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_with_http_info(**kwargs)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file(file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file(file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_with_http_info(**kwargs)
|
def show_file(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file(file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_with_http_info(**kwargs)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file(file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
77a7c44ab63cfc6e61b8547f58d56b21195ae460c035c0f929c68be496bc18bc
|
def show_file_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_with_http_info(file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file`')
collection_formats = {}
path_params = {}
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_with_http_info(file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_with_http_info(file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file`')
collection_formats = {}
path_params = {}
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_file_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_with_http_info(file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file`')
collection_formats = {}
path_params = {}
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_with_http_info(file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
99be00cffa926c3db5098813f92b0e6273ec676ec93f904a44b74ae4407baafd
|
def show_file_by_container(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_container(container_id=container_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_container_with_http_info(**kwargs)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_container(container_id=container_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_container
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_container(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_container(container_id=container_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_container_with_http_info(**kwargs)
|
def show_file_by_container(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_container(container_id=container_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_container_with_http_info(**kwargs)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_container(container_id=container_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
269bf5a8498b8fe91162c8bfa9f06fef5a05e4d0c6f77d3078903f04b0a4ec81
|
def show_file_by_container_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_container_with_http_info(container_id=container_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `show_file_by_container`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_container_with_http_info(container_id=container_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_container_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_container_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_container_with_http_info(container_id=container_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `show_file_by_container`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_file_by_container_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_container_with_http_info(container_id=container_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str container_id: Numeric ID or name of container. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['container_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_container" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('container_id' not in local_var_params) or (local_var_params['container_id'] is None))):
raise ApiValueError('Missing the required parameter `container_id` when calling `show_file_by_container`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_container`')
collection_formats = {}
path_params = {}
if ('container_id' in local_var_params):
path_params['container_id'] = local_var_params['container_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/containers/{container_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_container_with_http_info(container_id=container_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str container_id: Numeric ID or name of container. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
83d6930d7487ee3e03aaf21fdc44dee039c93b7e51eafcc1086c4481c3435d9c
|
def show_file_by_pool(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_pool_with_http_info(**kwargs)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_pool(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_pool_with_http_info(**kwargs)
|
def show_file_by_pool(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_pool_with_http_info(**kwargs)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
6df640f56de4e4cf84ce6f727d7b2e86dcb5eae896f5fd5eca407cebdc5f9d9f
|
def show_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
bbb608f01a522063e5f4556a3f3b99272e175e6e2904e9ccdf39d58ef9d499d3
|
def show_file_by_task(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_with_http_info(**kwargs)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_task(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_with_http_info(**kwargs)
|
def show_file_by_task(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_with_http_info(**kwargs)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
7acfdc9cb71e2489043c2d6836bc200a961e7798b4303574ce3fbe567aed14c5
|
def show_file_by_task_with_http_info(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `show_file_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_task_with_http_info(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `show_file_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_file_by_task_with_http_info(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `show_file_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_with_http_info(task_id=task_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
b8a5cdcdb54d13b353cab0d7173e6943df91b3e817688b00190ac67072939b19
|
def show_file_by_task_execution(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_execution_with_http_info(**kwargs)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_task_execution
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_task_execution(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_execution_with_http_info(**kwargs)
|
def show_file_by_task_execution(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_execution_with_http_info(**kwargs)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
62bbb3351592c24b2291761a4a58dcc9f36ceb14a177ff2f3f60481275752700
|
def show_file_by_task_execution_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `show_file_by_task_execution`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_task_execution_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_task_execution_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `show_file_by_task_execution`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_file_by_task_execution_with_http_info(self, **kwargs):
'Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task_execution" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `show_file_by_task_execution`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task_execution`')
collection_formats = {}
path_params = {}
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/task_executions/{task_execution_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution_with_http_info(task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
8f675cbebcd7035b18a7168bf29caa761f5923da5e939c8c94efe384bdd38bf4
|
def show_file_by_task_execution_by_task(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_execution_by_task_with_http_info(**kwargs)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_task_execution_by_task
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_task_execution_by_task(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_execution_by_task_with_http_info(**kwargs)
|
def show_file_by_task_execution_by_task(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: NodeumFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n "
kwargs['_return_http_data_only'] = True
return self.show_file_by_task_execution_by_task_with_http_info(**kwargs)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution_by_task(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: NodeumFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
23031fac520c4eb0c685d083142783405ff017123cf9e54f4caa3c384f5bab77
|
def show_file_by_task_execution_by_task_with_http_info(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `show_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `show_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_file_by_task_execution_by_task_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_file_by_task_execution_by_task_with_http_info(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `show_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `show_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_file_by_task_execution_by_task_with_http_info(self, **kwargs):
"Displays a specific file. # noqa: E501\n\n **API Key Scope**: files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)\n :param str task_execution_id: Numeric ID of task execution. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n "
local_var_params = locals()
all_params = ['task_id', 'task_execution_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_file_by_task_execution_by_task" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('task_id' not in local_var_params) or (local_var_params['task_id'] is None))):
raise ApiValueError('Missing the required parameter `task_id` when calling `show_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('task_execution_id' not in local_var_params) or (local_var_params['task_execution_id'] is None))):
raise ApiValueError('Missing the required parameter `task_execution_id` when calling `show_file_by_task_execution_by_task`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_file_by_task_execution_by_task`')
collection_formats = {}
path_params = {}
if ('task_id' in local_var_params):
path_params['task_id'] = local_var_params['task_id']
if ('task_execution_id' in local_var_params):
path_params['task_execution_id'] = local_var_params['task_execution_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='NodeumFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file. # noqa: E501
**API Key Scope**: files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_file_by_task_execution_by_task_with_http_info(task_id=task_id_value, task_execution_id=task_execution_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str task_id: Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. (required)
:param str task_execution_id: Numeric ID of task execution. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(NodeumFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
07499e57ad6d79aa401ca7adc44dd3ac117b3499256be47a2f84f4e2124bac0a
|
def show_import_file_by_pool(self, **kwargs):
'Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_import_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_import_file_by_pool_with_http_info(**kwargs)
|
Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_import_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImportFileWithPath
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_import_file_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_import_file_by_pool(self, **kwargs):
'Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_import_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_import_file_by_pool_with_http_info(**kwargs)
|
def show_import_file_by_pool(self, **kwargs):
'Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_import_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: ImportFileWithPath\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_import_file_by_pool_with_http_info(**kwargs)<|docstring|>Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_import_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ImportFileWithPath
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
bfd6bd8b8dc9aeae4e5f37e34bd130113739ac10e6c82bfc589ecadb46bb5c43
|
def show_import_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_import_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_import_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_import_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_import_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_import_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImportFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_import_file_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_import_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_import_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_import_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_import_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_import_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_import_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501\n\n **API Key Scope**: import_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_import_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(ImportFileWithPath, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_import_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_import_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_import_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/import_files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ImportFileWithPath', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file on tape of pools, specific for Data Exchange. # noqa: E501
**API Key Scope**: import_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_import_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ImportFileWithPath, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
6243f213a94058bb59e62e863e780a74521318066fe0c50d739cc24f18b7fe16
|
def show_on_tape_file_by_pool(self, **kwargs):
'Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_on_tape_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFile\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_on_tape_file_by_pool_with_http_info(**kwargs)
|
Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_on_tape_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OnTapesFile
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_on_tape_file_by_pool
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_on_tape_file_by_pool(self, **kwargs):
'Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_on_tape_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFile\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_on_tape_file_by_pool_with_http_info(**kwargs)
|
def show_on_tape_file_by_pool(self, **kwargs):
'Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_on_tape_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: OnTapesFile\n If the method is called asynchronously,\n returns the request thread.\n '
kwargs['_return_http_data_only'] = True
return self.show_on_tape_file_by_pool_with_http_info(**kwargs)<|docstring|>Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_on_tape_file_by_pool(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OnTapesFile
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
8c8bab3e98840ad86d68a95179f073f9f5ee3d50aeaa03b4d018a84ab4bc6bef
|
def show_on_tape_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_on_tape_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFile, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_on_tape_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_on_tape_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_on_tape_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFile', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_on_tape_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OnTapesFile, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
|
nodeum_sdk/api/files_api.py
|
show_on_tape_file_by_pool_with_http_info
|
nodeum-io/nodeum-sdk-python
| 0 |
python
|
def show_on_tape_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_on_tape_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFile, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_on_tape_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_on_tape_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_on_tape_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFile', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
|
def show_on_tape_file_by_pool_with_http_info(self, **kwargs):
'Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501\n\n **API Key Scope**: on_tapes_files / show # noqa: E501\n This method makes a synchronous HTTP request by default. To make an\n asynchronous HTTP request, please pass async_req=True\n >>> thread = api.show_on_tape_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)\n >>> result = thread.get()\n\n :param async_req bool: execute request asynchronously\n :param str pool_id: Numeric ID, or name of pool. (required)\n :param int file_id: Numeric ID of file. (required)\n :param _return_http_data_only: response data without head status code\n and headers\n :param _preload_content: if False, the urllib3.HTTPResponse object will\n be returned without reading/decoding response\n data. Default is True.\n :param _request_timeout: timeout setting for this request. If one\n number provided, it will be total request\n timeout. It can also be a pair (tuple) of\n (connection, read) timeouts.\n :return: tuple(OnTapesFile, status_code(int), headers(HTTPHeaderDict))\n If the method is called asynchronously,\n returns the request thread.\n '
local_var_params = locals()
all_params = ['pool_id', 'file_id']
all_params.extend(['async_req', '_return_http_data_only', '_preload_content', '_request_timeout'])
for (key, val) in six.iteritems(local_var_params['kwargs']):
if (key not in all_params):
raise ApiTypeError(("Got an unexpected keyword argument '%s' to method show_on_tape_file_by_pool" % key))
local_var_params[key] = val
del local_var_params['kwargs']
if (self.api_client.client_side_validation and (('pool_id' not in local_var_params) or (local_var_params['pool_id'] is None))):
raise ApiValueError('Missing the required parameter `pool_id` when calling `show_on_tape_file_by_pool`')
if (self.api_client.client_side_validation and (('file_id' not in local_var_params) or (local_var_params['file_id'] is None))):
raise ApiValueError('Missing the required parameter `file_id` when calling `show_on_tape_file_by_pool`')
collection_formats = {}
path_params = {}
if ('pool_id' in local_var_params):
path_params['pool_id'] = local_var_params['pool_id']
if ('file_id' in local_var_params):
path_params['file_id'] = local_var_params['file_id']
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
header_params['Accept'] = self.api_client.select_header_accept(['application/json'])
auth_settings = ['BasicAuth', 'BearerAuth']
return self.api_client.call_api('/pools/{pool_id}/on_tapes_files/{file_id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='OnTapesFile', auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)<|docstring|>Displays a specific file on tape of pools, specific for Active and Offline. # noqa: E501
**API Key Scope**: on_tapes_files / show # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.show_on_tape_file_by_pool_with_http_info(pool_id=pool_id_value, file_id=file_id_value, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str pool_id: Numeric ID, or name of pool. (required)
:param int file_id: Numeric ID of file. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OnTapesFile, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.<|endoftext|>
|
9335ad1847f74631d9fa44eb4a5f3fd9c06880f1b2987f676ea30ec575b43e3c
|
@gin.configurable('vgg', denylist=['example', 'prediction'])
def vgg_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)], vgg_model_file: str, weights: Optional[List[float]]=None) -> tf.Tensor:
"Perceptual loss for images in [0,1] color range.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image as 'image'.\n vgg_model_file: The path containing the vgg19 weights in MATLAB format.\n weights: An optional array of weights for different VGG layers. If None, the\n default weights are used (see vgg19.vgg_loss documentation).\n\n Returns:\n The perceptual loss.\n "
return vgg19.vgg_loss(prediction['image'], example['y'], vgg_model_file, weights)
|
Perceptual loss for images in [0,1] color range.
Args:
example: A dictionary with the ground truth image as 'y'.
prediction: The prediction dictionary with the image as 'image'.
vgg_model_file: The path containing the vgg19 weights in MATLAB format.
weights: An optional array of weights for different VGG layers. If None, the
default weights are used (see vgg19.vgg_loss documentation).
Returns:
The perceptual loss.
|
losses/losses.py
|
vgg_loss
|
vsewall/frame-interpolation
| 521 |
python
|
@gin.configurable('vgg', denylist=['example', 'prediction'])
def vgg_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)], vgg_model_file: str, weights: Optional[List[float]]=None) -> tf.Tensor:
"Perceptual loss for images in [0,1] color range.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image as 'image'.\n vgg_model_file: The path containing the vgg19 weights in MATLAB format.\n weights: An optional array of weights for different VGG layers. If None, the\n default weights are used (see vgg19.vgg_loss documentation).\n\n Returns:\n The perceptual loss.\n "
return vgg19.vgg_loss(prediction['image'], example['y'], vgg_model_file, weights)
|
@gin.configurable('vgg', denylist=['example', 'prediction'])
def vgg_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)], vgg_model_file: str, weights: Optional[List[float]]=None) -> tf.Tensor:
"Perceptual loss for images in [0,1] color range.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image as 'image'.\n vgg_model_file: The path containing the vgg19 weights in MATLAB format.\n weights: An optional array of weights for different VGG layers. If None, the\n default weights are used (see vgg19.vgg_loss documentation).\n\n Returns:\n The perceptual loss.\n "
return vgg19.vgg_loss(prediction['image'], example['y'], vgg_model_file, weights)<|docstring|>Perceptual loss for images in [0,1] color range.
Args:
example: A dictionary with the ground truth image as 'y'.
prediction: The prediction dictionary with the image as 'image'.
vgg_model_file: The path containing the vgg19 weights in MATLAB format.
weights: An optional array of weights for different VGG layers. If None, the
default weights are used (see vgg19.vgg_loss documentation).
Returns:
The perceptual loss.<|endoftext|>
|
e3e194acfb7a83fec0800a1dcb4a609fec251d6503272935b54d003522fe2f9c
|
@gin.configurable('style', denylist=['example', 'prediction'])
def style_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)], vgg_model_file: str, weights: Optional[List[float]]=None) -> tf.Tensor:
"Computes style loss from images in [0..1] color range.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image as 'image'.\n vgg_model_file: The path containing the vgg19 weights in MATLAB format.\n weights: An optional array of weights for different VGG layers. If None, the\n default weights are used (see vgg19.vgg_loss documentation).\n\n Returns:\n A tf.Tensor of a scalar representing the style loss computed over multiple\n vgg layer features.\n "
return vgg19.style_loss(prediction['image'], example['y'], vgg_model_file, weights)
|
Computes style loss from images in [0..1] color range.
Args:
example: A dictionary with the ground truth image as 'y'.
prediction: The prediction dictionary with the image as 'image'.
vgg_model_file: The path containing the vgg19 weights in MATLAB format.
weights: An optional array of weights for different VGG layers. If None, the
default weights are used (see vgg19.vgg_loss documentation).
Returns:
A tf.Tensor of a scalar representing the style loss computed over multiple
vgg layer features.
|
losses/losses.py
|
style_loss
|
vsewall/frame-interpolation
| 521 |
python
|
@gin.configurable('style', denylist=['example', 'prediction'])
def style_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)], vgg_model_file: str, weights: Optional[List[float]]=None) -> tf.Tensor:
"Computes style loss from images in [0..1] color range.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image as 'image'.\n vgg_model_file: The path containing the vgg19 weights in MATLAB format.\n weights: An optional array of weights for different VGG layers. If None, the\n default weights are used (see vgg19.vgg_loss documentation).\n\n Returns:\n A tf.Tensor of a scalar representing the style loss computed over multiple\n vgg layer features.\n "
return vgg19.style_loss(prediction['image'], example['y'], vgg_model_file, weights)
|
@gin.configurable('style', denylist=['example', 'prediction'])
def style_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)], vgg_model_file: str, weights: Optional[List[float]]=None) -> tf.Tensor:
"Computes style loss from images in [0..1] color range.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image as 'image'.\n vgg_model_file: The path containing the vgg19 weights in MATLAB format.\n weights: An optional array of weights for different VGG layers. If None, the\n default weights are used (see vgg19.vgg_loss documentation).\n\n Returns:\n A tf.Tensor of a scalar representing the style loss computed over multiple\n vgg layer features.\n "
return vgg19.style_loss(prediction['image'], example['y'], vgg_model_file, weights)<|docstring|>Computes style loss from images in [0..1] color range.
Args:
example: A dictionary with the ground truth image as 'y'.
prediction: The prediction dictionary with the image as 'image'.
vgg_model_file: The path containing the vgg19 weights in MATLAB format.
weights: An optional array of weights for different VGG layers. If None, the
default weights are used (see vgg19.vgg_loss documentation).
Returns:
A tf.Tensor of a scalar representing the style loss computed over multiple
vgg layer features.<|endoftext|>
|
0f05a3777e73ebf27d87f26477096fde1b7da9e686f8cd2328725ac36249ee85
|
def l1_warped_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)]) -> tf.Tensor:
"Computes an l1 loss using only warped images.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image(s) as 'x0_warped'\n and/or 'x1_warped'.\n\n Returns:\n A tf.Tensor of a scalar representing the linear combination of l1 losses\n between prediction images and y.\n "
loss = tf.constant(0.0, dtype=tf.float32)
if ('x0_warped' in prediction):
loss += tf.reduce_mean(tf.abs((prediction['x0_warped'] - example['y'])))
if ('x1_warped' in prediction):
loss += tf.reduce_mean(tf.abs((prediction['x1_warped'] - example['y'])))
return loss
|
Computes an l1 loss using only warped images.
Args:
example: A dictionary with the ground truth image as 'y'.
prediction: The prediction dictionary with the image(s) as 'x0_warped'
and/or 'x1_warped'.
Returns:
A tf.Tensor of a scalar representing the linear combination of l1 losses
between prediction images and y.
|
losses/losses.py
|
l1_warped_loss
|
vsewall/frame-interpolation
| 521 |
python
|
def l1_warped_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)]) -> tf.Tensor:
"Computes an l1 loss using only warped images.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image(s) as 'x0_warped'\n and/or 'x1_warped'.\n\n Returns:\n A tf.Tensor of a scalar representing the linear combination of l1 losses\n between prediction images and y.\n "
loss = tf.constant(0.0, dtype=tf.float32)
if ('x0_warped' in prediction):
loss += tf.reduce_mean(tf.abs((prediction['x0_warped'] - example['y'])))
if ('x1_warped' in prediction):
loss += tf.reduce_mean(tf.abs((prediction['x1_warped'] - example['y'])))
return loss
|
def l1_warped_loss(example: Mapping[(str, tf.Tensor)], prediction: Mapping[(str, tf.Tensor)]) -> tf.Tensor:
"Computes an l1 loss using only warped images.\n\n Args:\n example: A dictionary with the ground truth image as 'y'.\n prediction: The prediction dictionary with the image(s) as 'x0_warped'\n and/or 'x1_warped'.\n\n Returns:\n A tf.Tensor of a scalar representing the linear combination of l1 losses\n between prediction images and y.\n "
loss = tf.constant(0.0, dtype=tf.float32)
if ('x0_warped' in prediction):
loss += tf.reduce_mean(tf.abs((prediction['x0_warped'] - example['y'])))
if ('x1_warped' in prediction):
loss += tf.reduce_mean(tf.abs((prediction['x1_warped'] - example['y'])))
return loss<|docstring|>Computes an l1 loss using only warped images.
Args:
example: A dictionary with the ground truth image as 'y'.
prediction: The prediction dictionary with the image(s) as 'x0_warped'
and/or 'x1_warped'.
Returns:
A tf.Tensor of a scalar representing the linear combination of l1 losses
between prediction images and y.<|endoftext|>
|
b447d05ae54cc59d44cff5d6394f5b26c1568572a24eb5e9de25298e3338a999
|
def get_loss(loss_name: str) -> Callable[([Any, Any], tf.Tensor)]:
'Returns the loss function corresponding to the given name.'
if (loss_name == 'l1'):
return l1_loss
elif (loss_name == 'l2'):
return l2_loss
elif (loss_name == 'ssim'):
return ssim_loss
elif (loss_name == 'vgg'):
return vgg_loss
elif (loss_name == 'style'):
return style_loss
elif (loss_name == 'psnr'):
return psnr_loss
elif (loss_name == 'l1_warped'):
return l1_warped_loss
else:
raise ValueError(('Invalid loss function %s' % loss_name))
|
Returns the loss function corresponding to the given name.
|
losses/losses.py
|
get_loss
|
vsewall/frame-interpolation
| 521 |
python
|
def get_loss(loss_name: str) -> Callable[([Any, Any], tf.Tensor)]:
if (loss_name == 'l1'):
return l1_loss
elif (loss_name == 'l2'):
return l2_loss
elif (loss_name == 'ssim'):
return ssim_loss
elif (loss_name == 'vgg'):
return vgg_loss
elif (loss_name == 'style'):
return style_loss
elif (loss_name == 'psnr'):
return psnr_loss
elif (loss_name == 'l1_warped'):
return l1_warped_loss
else:
raise ValueError(('Invalid loss function %s' % loss_name))
|
def get_loss(loss_name: str) -> Callable[([Any, Any], tf.Tensor)]:
if (loss_name == 'l1'):
return l1_loss
elif (loss_name == 'l2'):
return l2_loss
elif (loss_name == 'ssim'):
return ssim_loss
elif (loss_name == 'vgg'):
return vgg_loss
elif (loss_name == 'style'):
return style_loss
elif (loss_name == 'psnr'):
return psnr_loss
elif (loss_name == 'l1_warped'):
return l1_warped_loss
else:
raise ValueError(('Invalid loss function %s' % loss_name))<|docstring|>Returns the loss function corresponding to the given name.<|endoftext|>
|
3d98f353ef4d5d77ec7c99406951f934f3c5b186665f90a47476678a3fcb09a6
|
def get_loss_op(loss_name):
'Returns a function for creating a loss calculation op.'
loss = get_loss(loss_name)
return (lambda example, prediction: loss(example, prediction))
|
Returns a function for creating a loss calculation op.
|
losses/losses.py
|
get_loss_op
|
vsewall/frame-interpolation
| 521 |
python
|
def get_loss_op(loss_name):
loss = get_loss(loss_name)
return (lambda example, prediction: loss(example, prediction))
|
def get_loss_op(loss_name):
loss = get_loss(loss_name)
return (lambda example, prediction: loss(example, prediction))<|docstring|>Returns a function for creating a loss calculation op.<|endoftext|>
|
f199861da4cbe3aee10252fe0ab7edd92b92b20d88ee622eb7e419a43d5ab993
|
def get_weight_op(weight_schedule):
'Returns a function for creating an iteration dependent loss weight op.'
return (lambda iterations: weight_schedule(iterations))
|
Returns a function for creating an iteration dependent loss weight op.
|
losses/losses.py
|
get_weight_op
|
vsewall/frame-interpolation
| 521 |
python
|
def get_weight_op(weight_schedule):
return (lambda iterations: weight_schedule(iterations))
|
def get_weight_op(weight_schedule):
return (lambda iterations: weight_schedule(iterations))<|docstring|>Returns a function for creating an iteration dependent loss weight op.<|endoftext|>
|
9c405180f4e95b063c0b3872358f8dd06ad4821c66137bece28bd6ce5ac68d64
|
def create_losses(loss_names: List[str], loss_weight_schedules: List[tf.keras.optimizers.schedules.LearningRateSchedule]) -> Dict[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
"Returns a dictionary of functions for creating loss and loss_weight ops.\n\n As an example, create_losses(['l1', 'l2'], [PiecewiseConstantDecay(),\n PiecewiseConstantDecay()]) returns a dictionary with two keys, and each value\n being a tuple of ops for loss calculation and loss_weight sampling.\n\n Args:\n loss_names: Names of the losses.\n loss_weight_schedules: Instances of loss weight schedules.\n\n Returns:\n A dictionary that contains the loss and weight schedule ops keyed by the\n names.\n "
losses = dict()
for (name, weight_schedule) in zip(loss_names, loss_weight_schedules):
unique_values = np.unique(weight_schedule.values)
if ((len(unique_values) == 1) and (unique_values[0] == 1.0)):
weighted_name = name
else:
weighted_name = ('k*' + name)
losses[weighted_name] = (get_loss_op(name), get_weight_op(weight_schedule))
return losses
|
Returns a dictionary of functions for creating loss and loss_weight ops.
As an example, create_losses(['l1', 'l2'], [PiecewiseConstantDecay(),
PiecewiseConstantDecay()]) returns a dictionary with two keys, and each value
being a tuple of ops for loss calculation and loss_weight sampling.
Args:
loss_names: Names of the losses.
loss_weight_schedules: Instances of loss weight schedules.
Returns:
A dictionary that contains the loss and weight schedule ops keyed by the
names.
|
losses/losses.py
|
create_losses
|
vsewall/frame-interpolation
| 521 |
python
|
def create_losses(loss_names: List[str], loss_weight_schedules: List[tf.keras.optimizers.schedules.LearningRateSchedule]) -> Dict[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
"Returns a dictionary of functions for creating loss and loss_weight ops.\n\n As an example, create_losses(['l1', 'l2'], [PiecewiseConstantDecay(),\n PiecewiseConstantDecay()]) returns a dictionary with two keys, and each value\n being a tuple of ops for loss calculation and loss_weight sampling.\n\n Args:\n loss_names: Names of the losses.\n loss_weight_schedules: Instances of loss weight schedules.\n\n Returns:\n A dictionary that contains the loss and weight schedule ops keyed by the\n names.\n "
losses = dict()
for (name, weight_schedule) in zip(loss_names, loss_weight_schedules):
unique_values = np.unique(weight_schedule.values)
if ((len(unique_values) == 1) and (unique_values[0] == 1.0)):
weighted_name = name
else:
weighted_name = ('k*' + name)
losses[weighted_name] = (get_loss_op(name), get_weight_op(weight_schedule))
return losses
|
def create_losses(loss_names: List[str], loss_weight_schedules: List[tf.keras.optimizers.schedules.LearningRateSchedule]) -> Dict[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
"Returns a dictionary of functions for creating loss and loss_weight ops.\n\n As an example, create_losses(['l1', 'l2'], [PiecewiseConstantDecay(),\n PiecewiseConstantDecay()]) returns a dictionary with two keys, and each value\n being a tuple of ops for loss calculation and loss_weight sampling.\n\n Args:\n loss_names: Names of the losses.\n loss_weight_schedules: Instances of loss weight schedules.\n\n Returns:\n A dictionary that contains the loss and weight schedule ops keyed by the\n names.\n "
losses = dict()
for (name, weight_schedule) in zip(loss_names, loss_weight_schedules):
unique_values = np.unique(weight_schedule.values)
if ((len(unique_values) == 1) and (unique_values[0] == 1.0)):
weighted_name = name
else:
weighted_name = ('k*' + name)
losses[weighted_name] = (get_loss_op(name), get_weight_op(weight_schedule))
return losses<|docstring|>Returns a dictionary of functions for creating loss and loss_weight ops.
As an example, create_losses(['l1', 'l2'], [PiecewiseConstantDecay(),
PiecewiseConstantDecay()]) returns a dictionary with two keys, and each value
being a tuple of ops for loss calculation and loss_weight sampling.
Args:
loss_names: Names of the losses.
loss_weight_schedules: Instances of loss weight schedules.
Returns:
A dictionary that contains the loss and weight schedule ops keyed by the
names.<|endoftext|>
|
13510420acc12e9021e029fa46d39cc99e438ea682a68e9e301fc9212ab5879f
|
@gin.configurable
def training_losses(loss_names: List[str], loss_weights: Optional[List[float]]=None, loss_weight_schedules: Optional[List[tf.keras.optimizers.schedules.LearningRateSchedule]]=None, loss_weight_parameters: Optional[List[Mapping[(str, List[Any])]]]=None) -> Mapping[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
'Creates the training loss functions and loss weight schedules.'
weight_schedules = []
if (not loss_weights):
for (weight_schedule, weight_parameters) in zip(loss_weight_schedules, loss_weight_parameters):
weight_schedules.append(weight_schedule(**weight_parameters))
else:
for loss_weight in loss_weights:
weight_parameters = {'boundaries': [0], 'values': (2 * [loss_weight])}
weight_schedules.append(tf.keras.optimizers.schedules.PiecewiseConstantDecay(**weight_parameters))
return create_losses(loss_names, weight_schedules)
|
Creates the training loss functions and loss weight schedules.
|
losses/losses.py
|
training_losses
|
vsewall/frame-interpolation
| 521 |
python
|
@gin.configurable
def training_losses(loss_names: List[str], loss_weights: Optional[List[float]]=None, loss_weight_schedules: Optional[List[tf.keras.optimizers.schedules.LearningRateSchedule]]=None, loss_weight_parameters: Optional[List[Mapping[(str, List[Any])]]]=None) -> Mapping[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
weight_schedules = []
if (not loss_weights):
for (weight_schedule, weight_parameters) in zip(loss_weight_schedules, loss_weight_parameters):
weight_schedules.append(weight_schedule(**weight_parameters))
else:
for loss_weight in loss_weights:
weight_parameters = {'boundaries': [0], 'values': (2 * [loss_weight])}
weight_schedules.append(tf.keras.optimizers.schedules.PiecewiseConstantDecay(**weight_parameters))
return create_losses(loss_names, weight_schedules)
|
@gin.configurable
def training_losses(loss_names: List[str], loss_weights: Optional[List[float]]=None, loss_weight_schedules: Optional[List[tf.keras.optimizers.schedules.LearningRateSchedule]]=None, loss_weight_parameters: Optional[List[Mapping[(str, List[Any])]]]=None) -> Mapping[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
weight_schedules = []
if (not loss_weights):
for (weight_schedule, weight_parameters) in zip(loss_weight_schedules, loss_weight_parameters):
weight_schedules.append(weight_schedule(**weight_parameters))
else:
for loss_weight in loss_weights:
weight_parameters = {'boundaries': [0], 'values': (2 * [loss_weight])}
weight_schedules.append(tf.keras.optimizers.schedules.PiecewiseConstantDecay(**weight_parameters))
return create_losses(loss_names, weight_schedules)<|docstring|>Creates the training loss functions and loss weight schedules.<|endoftext|>
|
c0b33ed27e00035a01f5de7093c15d9eeaeed35a1f930aa6d891a5bf5e0a3652
|
@gin.configurable
def test_losses(loss_names: List[str], loss_weights: Optional[List[float]]=None, loss_weight_schedules: Optional[List[tf.keras.optimizers.schedules.LearningRateSchedule]]=None, loss_weight_parameters: Optional[List[Mapping[(str, List[Any])]]]=None) -> Mapping[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
'Creates the test loss functions and loss weight schedules.'
weight_schedules = []
if (not loss_weights):
for (weight_schedule, weight_parameters) in zip(loss_weight_schedules, loss_weight_parameters):
weight_schedules.append(weight_schedule(**weight_parameters))
else:
for loss_weight in loss_weights:
weight_parameters = {'boundaries': [0], 'values': (2 * [loss_weight])}
weight_schedules.append(tf.keras.optimizers.schedules.PiecewiseConstantDecay(**weight_parameters))
return create_losses(loss_names, weight_schedules)
|
Creates the test loss functions and loss weight schedules.
|
losses/losses.py
|
test_losses
|
vsewall/frame-interpolation
| 521 |
python
|
@gin.configurable
def test_losses(loss_names: List[str], loss_weights: Optional[List[float]]=None, loss_weight_schedules: Optional[List[tf.keras.optimizers.schedules.LearningRateSchedule]]=None, loss_weight_parameters: Optional[List[Mapping[(str, List[Any])]]]=None) -> Mapping[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
weight_schedules = []
if (not loss_weights):
for (weight_schedule, weight_parameters) in zip(loss_weight_schedules, loss_weight_parameters):
weight_schedules.append(weight_schedule(**weight_parameters))
else:
for loss_weight in loss_weights:
weight_parameters = {'boundaries': [0], 'values': (2 * [loss_weight])}
weight_schedules.append(tf.keras.optimizers.schedules.PiecewiseConstantDecay(**weight_parameters))
return create_losses(loss_names, weight_schedules)
|
@gin.configurable
def test_losses(loss_names: List[str], loss_weights: Optional[List[float]]=None, loss_weight_schedules: Optional[List[tf.keras.optimizers.schedules.LearningRateSchedule]]=None, loss_weight_parameters: Optional[List[Mapping[(str, List[Any])]]]=None) -> Mapping[(str, Tuple[(Callable[([Any, Any], tf.Tensor)], Callable[([Any], tf.Tensor)])])]:
weight_schedules = []
if (not loss_weights):
for (weight_schedule, weight_parameters) in zip(loss_weight_schedules, loss_weight_parameters):
weight_schedules.append(weight_schedule(**weight_parameters))
else:
for loss_weight in loss_weights:
weight_parameters = {'boundaries': [0], 'values': (2 * [loss_weight])}
weight_schedules.append(tf.keras.optimizers.schedules.PiecewiseConstantDecay(**weight_parameters))
return create_losses(loss_names, weight_schedules)<|docstring|>Creates the test loss functions and loss weight schedules.<|endoftext|>
|
c8d6616f2d7ee79bc1f252b475e856a04ae522637ec29b302e7cdbd4a576e8b0
|
def aggregate_batch_losses(batch_losses: List[Mapping[(str, float)]]) -> Mapping[(str, float)]:
"Averages per batch losses into single dictionary for the whole epoch.\n\n As an example, if the batch_losses contained per batch losses:\n batch_losses = { {'l1': 0.2, 'ssim': 0.9}, {'l1': 0.3, 'ssim': 0.8}}\n The returned dictionary would look like: { 'l1': 0.25, 'ssim': 0.95 }\n\n Args:\n batch_losses: A list of dictionary objects, with one entry for each loss.\n\n Returns:\n Single dictionary with the losses aggregated.\n "
transp_losses = {}
for batch_loss in batch_losses:
for (loss_name, loss) in batch_loss.items():
if (loss_name not in transp_losses):
transp_losses[loss_name] = []
transp_losses[loss_name].append(loss)
aggregate_losses = {}
for loss_name in transp_losses:
aggregate_losses[loss_name] = np.mean(transp_losses[loss_name])
return aggregate_losses
|
Averages per batch losses into single dictionary for the whole epoch.
As an example, if the batch_losses contained per batch losses:
batch_losses = { {'l1': 0.2, 'ssim': 0.9}, {'l1': 0.3, 'ssim': 0.8}}
The returned dictionary would look like: { 'l1': 0.25, 'ssim': 0.95 }
Args:
batch_losses: A list of dictionary objects, with one entry for each loss.
Returns:
Single dictionary with the losses aggregated.
|
losses/losses.py
|
aggregate_batch_losses
|
vsewall/frame-interpolation
| 521 |
python
|
def aggregate_batch_losses(batch_losses: List[Mapping[(str, float)]]) -> Mapping[(str, float)]:
"Averages per batch losses into single dictionary for the whole epoch.\n\n As an example, if the batch_losses contained per batch losses:\n batch_losses = { {'l1': 0.2, 'ssim': 0.9}, {'l1': 0.3, 'ssim': 0.8}}\n The returned dictionary would look like: { 'l1': 0.25, 'ssim': 0.95 }\n\n Args:\n batch_losses: A list of dictionary objects, with one entry for each loss.\n\n Returns:\n Single dictionary with the losses aggregated.\n "
transp_losses = {}
for batch_loss in batch_losses:
for (loss_name, loss) in batch_loss.items():
if (loss_name not in transp_losses):
transp_losses[loss_name] = []
transp_losses[loss_name].append(loss)
aggregate_losses = {}
for loss_name in transp_losses:
aggregate_losses[loss_name] = np.mean(transp_losses[loss_name])
return aggregate_losses
|
def aggregate_batch_losses(batch_losses: List[Mapping[(str, float)]]) -> Mapping[(str, float)]:
"Averages per batch losses into single dictionary for the whole epoch.\n\n As an example, if the batch_losses contained per batch losses:\n batch_losses = { {'l1': 0.2, 'ssim': 0.9}, {'l1': 0.3, 'ssim': 0.8}}\n The returned dictionary would look like: { 'l1': 0.25, 'ssim': 0.95 }\n\n Args:\n batch_losses: A list of dictionary objects, with one entry for each loss.\n\n Returns:\n Single dictionary with the losses aggregated.\n "
transp_losses = {}
for batch_loss in batch_losses:
for (loss_name, loss) in batch_loss.items():
if (loss_name not in transp_losses):
transp_losses[loss_name] = []
transp_losses[loss_name].append(loss)
aggregate_losses = {}
for loss_name in transp_losses:
aggregate_losses[loss_name] = np.mean(transp_losses[loss_name])
return aggregate_losses<|docstring|>Averages per batch losses into single dictionary for the whole epoch.
As an example, if the batch_losses contained per batch losses:
batch_losses = { {'l1': 0.2, 'ssim': 0.9}, {'l1': 0.3, 'ssim': 0.8}}
The returned dictionary would look like: { 'l1': 0.25, 'ssim': 0.95 }
Args:
batch_losses: A list of dictionary objects, with one entry for each loss.
Returns:
Single dictionary with the losses aggregated.<|endoftext|>
|
6bb2bb6f7d10c0e45fd5629c3b15cc344c8dc062601508ef601ac5ea7e52fe7c
|
@staticmethod
def is_valid_ttl(ttl):
'Check if provided ttl value is in supported format i.e 1h, 12h, 2d'
return bool(re.match('\\d*d$|\\d*h$', ttl))
|
Check if provided ttl value is in supported format i.e 1h, 12h, 2d
|
modules/dbnd/src/targets/caching.py
|
is_valid_ttl
|
hugovk/dbnd
| 224 |
python
|
@staticmethod
def is_valid_ttl(ttl):
return bool(re.match('\\d*d$|\\d*h$', ttl))
|
@staticmethod
def is_valid_ttl(ttl):
return bool(re.match('\\d*d$|\\d*h$', ttl))<|docstring|>Check if provided ttl value is in supported format i.e 1h, 12h, 2d<|endoftext|>
|
9136b0f4cae5721a51639146f9c8ae473dedf5324fe1cb6393c3c8bd7324472d
|
@classmethod
def read(cls, file_target):
'Read file cache and create new instance of DbndFileCache'
cache_file_path = cls._resolve_cache_file_name(file_target.path)
with open(cache_file_path, 'r+') as f:
kwargs = json.loads(f.read())
return cls(**kwargs)
|
Read file cache and create new instance of DbndFileCache
|
modules/dbnd/src/targets/caching.py
|
read
|
hugovk/dbnd
| 224 |
python
|
@classmethod
def read(cls, file_target):
cache_file_path = cls._resolve_cache_file_name(file_target.path)
with open(cache_file_path, 'r+') as f:
kwargs = json.loads(f.read())
return cls(**kwargs)
|
@classmethod
def read(cls, file_target):
cache_file_path = cls._resolve_cache_file_name(file_target.path)
with open(cache_file_path, 'r+') as f:
kwargs = json.loads(f.read())
return cls(**kwargs)<|docstring|>Read file cache and create new instance of DbndFileCache<|endoftext|>
|
46a723794ae598a222f28fd38e16dd5d97f0d4460acd7446b518a568c3f7126d
|
def save(self):
'Save DbndFileCache instance to json-like cache file'
data = {'file_path': self._file_path, 'local_md5': self._local_md5, 'remote_md5': self._remote_md5, 'created_at': self._created_at.strftime(DbndLocalFileMetadataRegistry._date_format), 'ttl': self._ttl}
with open(self._cache_file_path, 'w+') as f:
f.write(json.dumps(data))
|
Save DbndFileCache instance to json-like cache file
|
modules/dbnd/src/targets/caching.py
|
save
|
hugovk/dbnd
| 224 |
python
|
def save(self):
data = {'file_path': self._file_path, 'local_md5': self._local_md5, 'remote_md5': self._remote_md5, 'created_at': self._created_at.strftime(DbndLocalFileMetadataRegistry._date_format), 'ttl': self._ttl}
with open(self._cache_file_path, 'w+') as f:
f.write(json.dumps(data))
|
def save(self):
data = {'file_path': self._file_path, 'local_md5': self._local_md5, 'remote_md5': self._remote_md5, 'created_at': self._created_at.strftime(DbndLocalFileMetadataRegistry._date_format), 'ttl': self._ttl}
with open(self._cache_file_path, 'w+') as f:
f.write(json.dumps(data))<|docstring|>Save DbndFileCache instance to json-like cache file<|endoftext|>
|
87ee0c710c30110baaf0dc0571ddf3d5cda6f448c4d51f71ba83a14e008fabb3
|
@staticmethod
def exists(file_target):
'Read existing cache file, if it not exists then return None'
cache_file_path = DbndLocalFileMetadataRegistry._resolve_cache_file_name(file_target.path)
return os.path.exists(cache_file_path)
|
Read existing cache file, if it not exists then return None
|
modules/dbnd/src/targets/caching.py
|
exists
|
hugovk/dbnd
| 224 |
python
|
@staticmethod
def exists(file_target):
cache_file_path = DbndLocalFileMetadataRegistry._resolve_cache_file_name(file_target.path)
return os.path.exists(cache_file_path)
|
@staticmethod
def exists(file_target):
cache_file_path = DbndLocalFileMetadataRegistry._resolve_cache_file_name(file_target.path)
return os.path.exists(cache_file_path)<|docstring|>Read existing cache file, if it not exists then return None<|endoftext|>
|
812b66060d42654a603a03af8a37dc16c9caab8de6dca9affab044fea83f5060
|
def delete(self):
'Remove cache file'
if os.path.isfile(self._cache_file_path):
os.remove(self._cache_file_path)
|
Remove cache file
|
modules/dbnd/src/targets/caching.py
|
delete
|
hugovk/dbnd
| 224 |
python
|
def delete(self):
if os.path.isfile(self._cache_file_path):
os.remove(self._cache_file_path)
|
def delete(self):
if os.path.isfile(self._cache_file_path):
os.remove(self._cache_file_path)<|docstring|>Remove cache file<|endoftext|>
|
daf532a040002c2ad27879ae79d7def69d35357334febdb8a423ad098bf9d7d6
|
@property
def expired(self):
'Check if cache file is still valid'
time_map = {'d': timedelta(days=1), 'h': timedelta(hours=1)}
interval_type = self._ttl[(- 1)]
interval_value = int(self._ttl[:(- 1)])
expired_at = (self._created_at + (interval_value * time_map[interval_type]))
return (expired_at < datetime.now())
|
Check if cache file is still valid
|
modules/dbnd/src/targets/caching.py
|
expired
|
hugovk/dbnd
| 224 |
python
|
@property
def expired(self):
time_map = {'d': timedelta(days=1), 'h': timedelta(hours=1)}
interval_type = self._ttl[(- 1)]
interval_value = int(self._ttl[:(- 1)])
expired_at = (self._created_at + (interval_value * time_map[interval_type]))
return (expired_at < datetime.now())
|
@property
def expired(self):
time_map = {'d': timedelta(days=1), 'h': timedelta(hours=1)}
interval_type = self._ttl[(- 1)]
interval_value = int(self._ttl[:(- 1)])
expired_at = (self._created_at + (interval_value * time_map[interval_type]))
return (expired_at < datetime.now())<|docstring|>Check if cache file is still valid<|endoftext|>
|
5b32b3e4792dc57794560dc1845abdc4899061f89d8c188771055ac1319c587f
|
def list(self, resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable['_models.PrivateEndpointConnectionListResult']:
'Returns the list of private endpoint connections.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :return: An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)\n :rtype: ~azure.core.async_paging.AsyncItemPaged[~kusto_management_client.models.PrivateEndpointConnectionListResult]\n :raises: ~azure.core.exceptions.HttpResponseError\n '
cls = kwargs.pop('cls', None)
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop('error_map', {}))
api_version = '2021-08-27'
accept = 'application/json'
def prepare_request(next_link=None):
header_parameters = {}
header_parameters['Accept'] = self._serialize.header('accept', accept, 'str')
if (not next_link):
url = self.list.metadata['url']
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str')}
url = self._client.format_url(url, **path_format_arguments)
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('api_version', api_version, 'str')
request = self._client.get(url, query_parameters, header_parameters)
else:
url = next_link
query_parameters = {}
request = self._client.get(url, query_parameters, header_parameters)
return request
async def extract_data(pipeline_response):
deserialized = self._deserialize('PrivateEndpointConnectionListResult', pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return (None, AsyncList(list_of_elem))
async def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = (await self._client._pipeline.run(request, stream=False, **kwargs))
response = pipeline_response.http_response
if (response.status_code not in [200]):
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)
|
Returns the list of private endpoint connections.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~kusto_management_client.models.PrivateEndpointConnectionListResult]
:raises: ~azure.core.exceptions.HttpResponseError
|
sdk/kusto/azure-mgmt-kusto/azure/mgmt/kusto/aio/operations/_private_endpoint_connections_operations.py
|
list
|
jayachithra/azure-sdk-for-python
| 2,728 |
python
|
def list(self, resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable['_models.PrivateEndpointConnectionListResult']:
'Returns the list of private endpoint connections.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :return: An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)\n :rtype: ~azure.core.async_paging.AsyncItemPaged[~kusto_management_client.models.PrivateEndpointConnectionListResult]\n :raises: ~azure.core.exceptions.HttpResponseError\n '
cls = kwargs.pop('cls', None)
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop('error_map', {}))
api_version = '2021-08-27'
accept = 'application/json'
def prepare_request(next_link=None):
header_parameters = {}
header_parameters['Accept'] = self._serialize.header('accept', accept, 'str')
if (not next_link):
url = self.list.metadata['url']
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str')}
url = self._client.format_url(url, **path_format_arguments)
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('api_version', api_version, 'str')
request = self._client.get(url, query_parameters, header_parameters)
else:
url = next_link
query_parameters = {}
request = self._client.get(url, query_parameters, header_parameters)
return request
async def extract_data(pipeline_response):
deserialized = self._deserialize('PrivateEndpointConnectionListResult', pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return (None, AsyncList(list_of_elem))
async def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = (await self._client._pipeline.run(request, stream=False, **kwargs))
response = pipeline_response.http_response
if (response.status_code not in [200]):
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)
|
def list(self, resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable['_models.PrivateEndpointConnectionListResult']:
'Returns the list of private endpoint connections.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :return: An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)\n :rtype: ~azure.core.async_paging.AsyncItemPaged[~kusto_management_client.models.PrivateEndpointConnectionListResult]\n :raises: ~azure.core.exceptions.HttpResponseError\n '
cls = kwargs.pop('cls', None)
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop('error_map', {}))
api_version = '2021-08-27'
accept = 'application/json'
def prepare_request(next_link=None):
header_parameters = {}
header_parameters['Accept'] = self._serialize.header('accept', accept, 'str')
if (not next_link):
url = self.list.metadata['url']
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str')}
url = self._client.format_url(url, **path_format_arguments)
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('api_version', api_version, 'str')
request = self._client.get(url, query_parameters, header_parameters)
else:
url = next_link
query_parameters = {}
request = self._client.get(url, query_parameters, header_parameters)
return request
async def extract_data(pipeline_response):
deserialized = self._deserialize('PrivateEndpointConnectionListResult', pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem)
return (None, AsyncList(list_of_elem))
async def get_next(next_link=None):
request = prepare_request(next_link)
pipeline_response = (await self._client._pipeline.run(request, stream=False, **kwargs))
response = pipeline_response.http_response
if (response.status_code not in [200]):
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return AsyncItemPaged(get_next, extract_data)<|docstring|>Returns the list of private endpoint connections.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)
:rtype: ~azure.core.async_paging.AsyncItemPaged[~kusto_management_client.models.PrivateEndpointConnectionListResult]
:raises: ~azure.core.exceptions.HttpResponseError<|endoftext|>
|
abb36149d6a616413e919958fefbf6445187d476a5b3f651f621162df28c5c7c
|
async def get(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> '_models.PrivateEndpointConnection':
'Gets a private endpoint connection.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :return: PrivateEndpointConnection, or the result of cls(response)\n :rtype: ~kusto_management_client.models.PrivateEndpointConnection\n :raises: ~azure.core.exceptions.HttpResponseError\n '
cls = kwargs.pop('cls', None)
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop('error_map', {}))
api_version = '2021-08-27'
accept = 'application/json'
url = self.get.metadata['url']
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
url = self._client.format_url(url, **path_format_arguments)
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('api_version', api_version, 'str')
header_parameters = {}
header_parameters['Accept'] = self._serialize.header('accept', accept, 'str')
request = self._client.get(url, query_parameters, header_parameters)
pipeline_response = (await self._client._pipeline.run(request, stream=False, **kwargs))
response = pipeline_response.http_response
if (response.status_code not in [200]):
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize('PrivateEndpointConnection', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
|
Gets a private endpoint connection.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection.
:type private_endpoint_connection_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: PrivateEndpointConnection, or the result of cls(response)
:rtype: ~kusto_management_client.models.PrivateEndpointConnection
:raises: ~azure.core.exceptions.HttpResponseError
|
sdk/kusto/azure-mgmt-kusto/azure/mgmt/kusto/aio/operations/_private_endpoint_connections_operations.py
|
get
|
jayachithra/azure-sdk-for-python
| 2,728 |
python
|
async def get(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> '_models.PrivateEndpointConnection':
'Gets a private endpoint connection.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :return: PrivateEndpointConnection, or the result of cls(response)\n :rtype: ~kusto_management_client.models.PrivateEndpointConnection\n :raises: ~azure.core.exceptions.HttpResponseError\n '
cls = kwargs.pop('cls', None)
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop('error_map', {}))
api_version = '2021-08-27'
accept = 'application/json'
url = self.get.metadata['url']
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
url = self._client.format_url(url, **path_format_arguments)
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('api_version', api_version, 'str')
header_parameters = {}
header_parameters['Accept'] = self._serialize.header('accept', accept, 'str')
request = self._client.get(url, query_parameters, header_parameters)
pipeline_response = (await self._client._pipeline.run(request, stream=False, **kwargs))
response = pipeline_response.http_response
if (response.status_code not in [200]):
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize('PrivateEndpointConnection', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
|
async def get(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> '_models.PrivateEndpointConnection':
'Gets a private endpoint connection.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :return: PrivateEndpointConnection, or the result of cls(response)\n :rtype: ~kusto_management_client.models.PrivateEndpointConnection\n :raises: ~azure.core.exceptions.HttpResponseError\n '
cls = kwargs.pop('cls', None)
error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
error_map.update(kwargs.pop('error_map', {}))
api_version = '2021-08-27'
accept = 'application/json'
url = self.get.metadata['url']
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
url = self._client.format_url(url, **path_format_arguments)
query_parameters = {}
query_parameters['api-version'] = self._serialize.query('api_version', api_version, 'str')
header_parameters = {}
header_parameters['Accept'] = self._serialize.header('accept', accept, 'str')
request = self._client.get(url, query_parameters, header_parameters)
pipeline_response = (await self._client._pipeline.run(request, stream=False, **kwargs))
response = pipeline_response.http_response
if (response.status_code not in [200]):
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize('PrivateEndpointConnection', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized<|docstring|>Gets a private endpoint connection.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection.
:type private_endpoint_connection_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: PrivateEndpointConnection, or the result of cls(response)
:rtype: ~kusto_management_client.models.PrivateEndpointConnection
:raises: ~azure.core.exceptions.HttpResponseError<|endoftext|>
|
4f7699d666c7845ca0fc5d0eb48cda6aa4c36310df0d8eff8f8e59fbb6ebb31b
|
async def begin_create_or_update(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, parameters: '_models.PrivateEndpointConnection', **kwargs: Any) -> AsyncLROPoller['_models.PrivateEndpointConnection']:
'Approve or reject a private endpoint connection with a given name.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :param parameters:\n :type parameters: ~kusto_management_client.models.PrivateEndpointConnection\n :keyword callable cls: A custom type or function that will be passed the direct response\n :keyword str continuation_token: A continuation token to restart a poller from a saved state.\n :keyword polling: By default, your polling method will be AsyncARMPolling.\n Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.\n :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.\n :return: An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)\n :rtype: ~azure.core.polling.AsyncLROPoller[~kusto_management_client.models.PrivateEndpointConnection]\n :raises ~azure.core.exceptions.HttpResponseError:\n '
polling = kwargs.pop('polling', True)
cls = kwargs.pop('cls', None)
lro_delay = kwargs.pop('polling_interval', self._config.polling_interval)
cont_token = kwargs.pop('continuation_token', None)
if (cont_token is None):
raw_result = (await self._create_or_update_initial(resource_group_name=resource_group_name, cluster_name=cluster_name, private_endpoint_connection_name=private_endpoint_connection_name, parameters=parameters, cls=(lambda x, y, z: x), **kwargs))
kwargs.pop('error_map', None)
kwargs.pop('content_type', None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize('PrivateEndpointConnection', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
if (polling is True):
polling_method = AsyncARMPolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs)
elif (polling is False):
polling_method = AsyncNoPolling()
else:
polling_method = polling
if cont_token:
return AsyncLROPoller.from_continuation_token(polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output)
else:
return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method)
|
Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection.
:type private_endpoint_connection_name: str
:param parameters:
:type parameters: ~kusto_management_client.models.PrivateEndpointConnection
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be AsyncARMPolling.
Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
:paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
:return: An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~kusto_management_client.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:
|
sdk/kusto/azure-mgmt-kusto/azure/mgmt/kusto/aio/operations/_private_endpoint_connections_operations.py
|
begin_create_or_update
|
jayachithra/azure-sdk-for-python
| 2,728 |
python
|
async def begin_create_or_update(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, parameters: '_models.PrivateEndpointConnection', **kwargs: Any) -> AsyncLROPoller['_models.PrivateEndpointConnection']:
'Approve or reject a private endpoint connection with a given name.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :param parameters:\n :type parameters: ~kusto_management_client.models.PrivateEndpointConnection\n :keyword callable cls: A custom type or function that will be passed the direct response\n :keyword str continuation_token: A continuation token to restart a poller from a saved state.\n :keyword polling: By default, your polling method will be AsyncARMPolling.\n Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.\n :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.\n :return: An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)\n :rtype: ~azure.core.polling.AsyncLROPoller[~kusto_management_client.models.PrivateEndpointConnection]\n :raises ~azure.core.exceptions.HttpResponseError:\n '
polling = kwargs.pop('polling', True)
cls = kwargs.pop('cls', None)
lro_delay = kwargs.pop('polling_interval', self._config.polling_interval)
cont_token = kwargs.pop('continuation_token', None)
if (cont_token is None):
raw_result = (await self._create_or_update_initial(resource_group_name=resource_group_name, cluster_name=cluster_name, private_endpoint_connection_name=private_endpoint_connection_name, parameters=parameters, cls=(lambda x, y, z: x), **kwargs))
kwargs.pop('error_map', None)
kwargs.pop('content_type', None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize('PrivateEndpointConnection', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
if (polling is True):
polling_method = AsyncARMPolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs)
elif (polling is False):
polling_method = AsyncNoPolling()
else:
polling_method = polling
if cont_token:
return AsyncLROPoller.from_continuation_token(polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output)
else:
return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method)
|
async def begin_create_or_update(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, parameters: '_models.PrivateEndpointConnection', **kwargs: Any) -> AsyncLROPoller['_models.PrivateEndpointConnection']:
'Approve or reject a private endpoint connection with a given name.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :param parameters:\n :type parameters: ~kusto_management_client.models.PrivateEndpointConnection\n :keyword callable cls: A custom type or function that will be passed the direct response\n :keyword str continuation_token: A continuation token to restart a poller from a saved state.\n :keyword polling: By default, your polling method will be AsyncARMPolling.\n Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.\n :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.\n :return: An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)\n :rtype: ~azure.core.polling.AsyncLROPoller[~kusto_management_client.models.PrivateEndpointConnection]\n :raises ~azure.core.exceptions.HttpResponseError:\n '
polling = kwargs.pop('polling', True)
cls = kwargs.pop('cls', None)
lro_delay = kwargs.pop('polling_interval', self._config.polling_interval)
cont_token = kwargs.pop('continuation_token', None)
if (cont_token is None):
raw_result = (await self._create_or_update_initial(resource_group_name=resource_group_name, cluster_name=cluster_name, private_endpoint_connection_name=private_endpoint_connection_name, parameters=parameters, cls=(lambda x, y, z: x), **kwargs))
kwargs.pop('error_map', None)
kwargs.pop('content_type', None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize('PrivateEndpointConnection', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
if (polling is True):
polling_method = AsyncARMPolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs)
elif (polling is False):
polling_method = AsyncNoPolling()
else:
polling_method = polling
if cont_token:
return AsyncLROPoller.from_continuation_token(polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output)
else:
return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method)<|docstring|>Approve or reject a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection.
:type private_endpoint_connection_name: str
:param parameters:
:type parameters: ~kusto_management_client.models.PrivateEndpointConnection
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be AsyncARMPolling.
Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
:paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
:return: An instance of AsyncLROPoller that returns either PrivateEndpointConnection or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[~kusto_management_client.models.PrivateEndpointConnection]
:raises ~azure.core.exceptions.HttpResponseError:<|endoftext|>
|
b1071932eb657c298ccbef09c2374055512ab335b8766a63b169bbeccdce6456
|
async def begin_delete(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[None]:
'Deletes a private endpoint connection with a given name.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :keyword str continuation_token: A continuation token to restart a poller from a saved state.\n :keyword polling: By default, your polling method will be AsyncARMPolling.\n Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.\n :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.\n :return: An instance of AsyncLROPoller that returns either None or the result of cls(response)\n :rtype: ~azure.core.polling.AsyncLROPoller[None]\n :raises ~azure.core.exceptions.HttpResponseError:\n '
polling = kwargs.pop('polling', True)
cls = kwargs.pop('cls', None)
lro_delay = kwargs.pop('polling_interval', self._config.polling_interval)
cont_token = kwargs.pop('continuation_token', None)
if (cont_token is None):
raw_result = (await self._delete_initial(resource_group_name=resource_group_name, cluster_name=cluster_name, private_endpoint_connection_name=private_endpoint_connection_name, cls=(lambda x, y, z: x), **kwargs))
kwargs.pop('error_map', None)
kwargs.pop('content_type', None)
def get_long_running_output(pipeline_response):
if cls:
return cls(pipeline_response, None, {})
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
if (polling is True):
polling_method = AsyncARMPolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs)
elif (polling is False):
polling_method = AsyncNoPolling()
else:
polling_method = polling
if cont_token:
return AsyncLROPoller.from_continuation_token(polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output)
else:
return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method)
|
Deletes a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection.
:type private_endpoint_connection_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be AsyncARMPolling.
Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
:paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:
|
sdk/kusto/azure-mgmt-kusto/azure/mgmt/kusto/aio/operations/_private_endpoint_connections_operations.py
|
begin_delete
|
jayachithra/azure-sdk-for-python
| 2,728 |
python
|
async def begin_delete(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[None]:
'Deletes a private endpoint connection with a given name.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :keyword str continuation_token: A continuation token to restart a poller from a saved state.\n :keyword polling: By default, your polling method will be AsyncARMPolling.\n Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.\n :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.\n :return: An instance of AsyncLROPoller that returns either None or the result of cls(response)\n :rtype: ~azure.core.polling.AsyncLROPoller[None]\n :raises ~azure.core.exceptions.HttpResponseError:\n '
polling = kwargs.pop('polling', True)
cls = kwargs.pop('cls', None)
lro_delay = kwargs.pop('polling_interval', self._config.polling_interval)
cont_token = kwargs.pop('continuation_token', None)
if (cont_token is None):
raw_result = (await self._delete_initial(resource_group_name=resource_group_name, cluster_name=cluster_name, private_endpoint_connection_name=private_endpoint_connection_name, cls=(lambda x, y, z: x), **kwargs))
kwargs.pop('error_map', None)
kwargs.pop('content_type', None)
def get_long_running_output(pipeline_response):
if cls:
return cls(pipeline_response, None, {})
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
if (polling is True):
polling_method = AsyncARMPolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs)
elif (polling is False):
polling_method = AsyncNoPolling()
else:
polling_method = polling
if cont_token:
return AsyncLROPoller.from_continuation_token(polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output)
else:
return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method)
|
async def begin_delete(self, resource_group_name: str, cluster_name: str, private_endpoint_connection_name: str, **kwargs: Any) -> AsyncLROPoller[None]:
'Deletes a private endpoint connection with a given name.\n\n :param resource_group_name: The name of the resource group containing the Kusto cluster.\n :type resource_group_name: str\n :param cluster_name: The name of the Kusto cluster.\n :type cluster_name: str\n :param private_endpoint_connection_name: The name of the private endpoint connection.\n :type private_endpoint_connection_name: str\n :keyword callable cls: A custom type or function that will be passed the direct response\n :keyword str continuation_token: A continuation token to restart a poller from a saved state.\n :keyword polling: By default, your polling method will be AsyncARMPolling.\n Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.\n :paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.\n :return: An instance of AsyncLROPoller that returns either None or the result of cls(response)\n :rtype: ~azure.core.polling.AsyncLROPoller[None]\n :raises ~azure.core.exceptions.HttpResponseError:\n '
polling = kwargs.pop('polling', True)
cls = kwargs.pop('cls', None)
lro_delay = kwargs.pop('polling_interval', self._config.polling_interval)
cont_token = kwargs.pop('continuation_token', None)
if (cont_token is None):
raw_result = (await self._delete_initial(resource_group_name=resource_group_name, cluster_name=cluster_name, private_endpoint_connection_name=private_endpoint_connection_name, cls=(lambda x, y, z: x), **kwargs))
kwargs.pop('error_map', None)
kwargs.pop('content_type', None)
def get_long_running_output(pipeline_response):
if cls:
return cls(pipeline_response, None, {})
path_format_arguments = {'subscriptionId': self._serialize.url('self._config.subscription_id', self._config.subscription_id, 'str'), 'resourceGroupName': self._serialize.url('resource_group_name', resource_group_name, 'str'), 'clusterName': self._serialize.url('cluster_name', cluster_name, 'str'), 'privateEndpointConnectionName': self._serialize.url('private_endpoint_connection_name', private_endpoint_connection_name, 'str')}
if (polling is True):
polling_method = AsyncARMPolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs)
elif (polling is False):
polling_method = AsyncNoPolling()
else:
polling_method = polling
if cont_token:
return AsyncLROPoller.from_continuation_token(polling_method=polling_method, continuation_token=cont_token, client=self._client, deserialization_callback=get_long_running_output)
else:
return AsyncLROPoller(self._client, raw_result, get_long_running_output, polling_method)<|docstring|>Deletes a private endpoint connection with a given name.
:param resource_group_name: The name of the resource group containing the Kusto cluster.
:type resource_group_name: str
:param cluster_name: The name of the Kusto cluster.
:type cluster_name: str
:param private_endpoint_connection_name: The name of the private endpoint connection.
:type private_endpoint_connection_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be AsyncARMPolling.
Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
:paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
:return: An instance of AsyncLROPoller that returns either None or the result of cls(response)
:rtype: ~azure.core.polling.AsyncLROPoller[None]
:raises ~azure.core.exceptions.HttpResponseError:<|endoftext|>
|
963cfafc4acc3cf244cf1d01d7d6a3097c5c151cceb0e068af3fec36b26fe534
|
def __init__(self, url, message=None):
'\n @param url: The url for the request.\n @type url: str\n @param message: The (optional) message to be send in the request.\n @type message: str\n '
self.url = url
self.headers = {}
self.message = message
|
@param url: The url for the request.
@type url: str
@param message: The (optional) message to be send in the request.
@type message: str
|
suds/transport/__init__.py
|
__init__
|
ChristianTreo/interactive-tutorials
| 2,750 |
python
|
def __init__(self, url, message=None):
'\n @param url: The url for the request.\n @type url: str\n @param message: The (optional) message to be send in the request.\n @type message: str\n '
self.url = url
self.headers = {}
self.message = message
|
def __init__(self, url, message=None):
'\n @param url: The url for the request.\n @type url: str\n @param message: The (optional) message to be send in the request.\n @type message: str\n '
self.url = url
self.headers = {}
self.message = message<|docstring|>@param url: The url for the request.
@type url: str
@param message: The (optional) message to be send in the request.
@type message: str<|endoftext|>
|
0152c9dd23219365cc78b9294008ca490a9463b994cb7bf8df6319962622e42a
|
def __init__(self, code, headers, message):
'\n @param code: The http code returned.\n @type code: int\n @param headers: The http returned headers.\n @type headers: dict\n @param message: The (optional) reply message received.\n @type message: str\n '
self.code = code
self.headers = headers
self.message = message
|
@param code: The http code returned.
@type code: int
@param headers: The http returned headers.
@type headers: dict
@param message: The (optional) reply message received.
@type message: str
|
suds/transport/__init__.py
|
__init__
|
ChristianTreo/interactive-tutorials
| 2,750 |
python
|
def __init__(self, code, headers, message):
'\n @param code: The http code returned.\n @type code: int\n @param headers: The http returned headers.\n @type headers: dict\n @param message: The (optional) reply message received.\n @type message: str\n '
self.code = code
self.headers = headers
self.message = message
|
def __init__(self, code, headers, message):
'\n @param code: The http code returned.\n @type code: int\n @param headers: The http returned headers.\n @type headers: dict\n @param message: The (optional) reply message received.\n @type message: str\n '
self.code = code
self.headers = headers
self.message = message<|docstring|>@param code: The http code returned.
@type code: int
@param headers: The http returned headers.
@type headers: dict
@param message: The (optional) reply message received.
@type message: str<|endoftext|>
|
21c43a8756587e8ca71e8410e7bae9342e5bf4331cc583481f19e471b4830957
|
def __init__(self):
'\n Constructor.\n '
from suds.transport.options import Options
self.options = Options()
del Options
|
Constructor.
|
suds/transport/__init__.py
|
__init__
|
ChristianTreo/interactive-tutorials
| 2,750 |
python
|
def __init__(self):
'\n \n '
from suds.transport.options import Options
self.options = Options()
del Options
|
def __init__(self):
'\n \n '
from suds.transport.options import Options
self.options = Options()
del Options<|docstring|>Constructor.<|endoftext|>
|
9e73d9d5844257273498f11c73b92eea4c3c2ffd44672d3db6249ec3b858b7ab
|
def open(self, request):
'\n Open the url in the specified request.\n @param request: A transport request.\n @type request: L{Request}\n @return: An input stream.\n @rtype: stream\n @raise TransportError: On all transport errors.\n '
raise Exception('not-implemented')
|
Open the url in the specified request.
@param request: A transport request.
@type request: L{Request}
@return: An input stream.
@rtype: stream
@raise TransportError: On all transport errors.
|
suds/transport/__init__.py
|
open
|
ChristianTreo/interactive-tutorials
| 2,750 |
python
|
def open(self, request):
'\n Open the url in the specified request.\n @param request: A transport request.\n @type request: L{Request}\n @return: An input stream.\n @rtype: stream\n @raise TransportError: On all transport errors.\n '
raise Exception('not-implemented')
|
def open(self, request):
'\n Open the url in the specified request.\n @param request: A transport request.\n @type request: L{Request}\n @return: An input stream.\n @rtype: stream\n @raise TransportError: On all transport errors.\n '
raise Exception('not-implemented')<|docstring|>Open the url in the specified request.
@param request: A transport request.
@type request: L{Request}
@return: An input stream.
@rtype: stream
@raise TransportError: On all transport errors.<|endoftext|>
|
4d8518c527db37e53b9b10b424f9560fd2e9b1a86a37bbec657b048f89288e5e
|
def send(self, request):
'\n Send soap message. Implementations are expected to handle:\n - proxies\n - I{http} headers\n - cookies\n - sending message\n - brokering exceptions into L{TransportError}\n @param request: A transport request.\n @type request: L{Request}\n @return: The reply\n @rtype: L{Reply}\n @raise TransportError: On all transport errors.\n '
raise Exception('not-implemented')
|
Send soap message. Implementations are expected to handle:
- proxies
- I{http} headers
- cookies
- sending message
- brokering exceptions into L{TransportError}
@param request: A transport request.
@type request: L{Request}
@return: The reply
@rtype: L{Reply}
@raise TransportError: On all transport errors.
|
suds/transport/__init__.py
|
send
|
ChristianTreo/interactive-tutorials
| 2,750 |
python
|
def send(self, request):
'\n Send soap message. Implementations are expected to handle:\n - proxies\n - I{http} headers\n - cookies\n - sending message\n - brokering exceptions into L{TransportError}\n @param request: A transport request.\n @type request: L{Request}\n @return: The reply\n @rtype: L{Reply}\n @raise TransportError: On all transport errors.\n '
raise Exception('not-implemented')
|
def send(self, request):
'\n Send soap message. Implementations are expected to handle:\n - proxies\n - I{http} headers\n - cookies\n - sending message\n - brokering exceptions into L{TransportError}\n @param request: A transport request.\n @type request: L{Request}\n @return: The reply\n @rtype: L{Reply}\n @raise TransportError: On all transport errors.\n '
raise Exception('not-implemented')<|docstring|>Send soap message. Implementations are expected to handle:
- proxies
- I{http} headers
- cookies
- sending message
- brokering exceptions into L{TransportError}
@param request: A transport request.
@type request: L{Request}
@return: The reply
@rtype: L{Reply}
@raise TransportError: On all transport errors.<|endoftext|>
|
d1eaab421330bcfc152f0be9f7a081e99edfbea7b6a03b22aa32b522bddb751e
|
def forward(self, x, train=False):
'\n :param x:\n :param train:\n :return:\n '
es_time = time.time()
encoder = self.encoder(x, train)
e_time = (time.time() - es_time)
ed_time = time.time()
(accu, law) = self.decoder(encoder)
d_time = (time.time() - ed_time)
return (accu, law, e_time, d_time)
|
:param x:
:param train:
:return:
|
models/models_AL/Joint.py
|
forward
|
bamtercelboo/PyTorch-Bert-BiLSTM-ATT-LJP
| 10 |
python
|
def forward(self, x, train=False):
'\n :param x:\n :param train:\n :return:\n '
es_time = time.time()
encoder = self.encoder(x, train)
e_time = (time.time() - es_time)
ed_time = time.time()
(accu, law) = self.decoder(encoder)
d_time = (time.time() - ed_time)
return (accu, law, e_time, d_time)
|
def forward(self, x, train=False):
'\n :param x:\n :param train:\n :return:\n '
es_time = time.time()
encoder = self.encoder(x, train)
e_time = (time.time() - es_time)
ed_time = time.time()
(accu, law) = self.decoder(encoder)
d_time = (time.time() - ed_time)
return (accu, law, e_time, d_time)<|docstring|>:param x:
:param train:
:return:<|endoftext|>
|
e702271e60d18782af3432a2d871f24d3422574d569e473df77fced54540c8d2
|
def __init__(self, es, nu):
'\n\n :param es:\n :param nu: The kinematic viscosity nu = mu / rho\n '
super(incompressibleNavierStokesBase, self).__init__(es)
assert (isinstance(nu, (int, float)) and (nu >= 0)), f'kinematic viscosity = {nu} is wrong.'
self._nu_ = nu
self._velocity_ = None
self._vorticity_ = None
self._body_force_ = None
self._pressure_ = None
self._gradient_of_pressure_ = None
self._total_pressure_ = None
self._kinetic_energy_distribution_ = None
self._curl_of_omega_ = None
self._NPDf_u_ = None
self._NPDf_v_ = None
self._NPDf_p_ = None
self._NPDf_tp_ = None
self._NPDf_omega_ = None
self._freeze_self_()
|
:param es:
:param nu: The kinematic viscosity nu = mu / rho
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
__init__
|
mathischeap/mifem
| 1 |
python
|
def __init__(self, es, nu):
'\n\n :param es:\n :param nu: The kinematic viscosity nu = mu / rho\n '
super(incompressibleNavierStokesBase, self).__init__(es)
assert (isinstance(nu, (int, float)) and (nu >= 0)), f'kinematic viscosity = {nu} is wrong.'
self._nu_ = nu
self._velocity_ = None
self._vorticity_ = None
self._body_force_ = None
self._pressure_ = None
self._gradient_of_pressure_ = None
self._total_pressure_ = None
self._kinetic_energy_distribution_ = None
self._curl_of_omega_ = None
self._NPDf_u_ = None
self._NPDf_v_ = None
self._NPDf_p_ = None
self._NPDf_tp_ = None
self._NPDf_omega_ = None
self._freeze_self_()
|
def __init__(self, es, nu):
'\n\n :param es:\n :param nu: The kinematic viscosity nu = mu / rho\n '
super(incompressibleNavierStokesBase, self).__init__(es)
assert (isinstance(nu, (int, float)) and (nu >= 0)), f'kinematic viscosity = {nu} is wrong.'
self._nu_ = nu
self._velocity_ = None
self._vorticity_ = None
self._body_force_ = None
self._pressure_ = None
self._gradient_of_pressure_ = None
self._total_pressure_ = None
self._kinetic_energy_distribution_ = None
self._curl_of_omega_ = None
self._NPDf_u_ = None
self._NPDf_v_ = None
self._NPDf_p_ = None
self._NPDf_tp_ = None
self._NPDf_omega_ = None
self._freeze_self_()<|docstring|>:param es:
:param nu: The kinematic viscosity nu = mu / rho<|endoftext|>
|
708674e329285703b36b08d8e8da8b814f0ed99dd145216b5a16a9365b4b8fe7
|
@property
def nu(self):
'The kinematic viscosity.'
return self._nu_
|
The kinematic viscosity.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
nu
|
mathischeap/mifem
| 1 |
python
|
@property
def nu(self):
return self._nu_
|
@property
def nu(self):
return self._nu_<|docstring|>The kinematic viscosity.<|endoftext|>
|
123309c8f3d0c3be2436f8d39ffe0e98ea7bab4c32fe5c121f3645fea73e19ee
|
@property
def Re(self):
'Reynolds number. It will also depend on the computational domain and velocity.'
raise NotImplementedError()
|
Reynolds number. It will also depend on the computational domain and velocity.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
Re
|
mathischeap/mifem
| 1 |
python
|
@property
def Re(self):
raise NotImplementedError()
|
@property
def Re(self):
raise NotImplementedError()<|docstring|>Reynolds number. It will also depend on the computational domain and velocity.<|endoftext|>
|
80e22242719e0acd1c0ac2cc8b74fb1aa6682fd77b11e77385953d145b5cf969
|
@property
def velocity(self):
'A scalar field of the kinetic energy distribution.'
if (self._velocity_ is None):
self._velocity_ = _2dCSCG_VectorField(self.mesh, [self.u, self.v], valid_time=self.valid_time, name='velocity')
return self._velocity_
|
A scalar field of the kinetic energy distribution.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
velocity
|
mathischeap/mifem
| 1 |
python
|
@property
def velocity(self):
if (self._velocity_ is None):
self._velocity_ = _2dCSCG_VectorField(self.mesh, [self.u, self.v], valid_time=self.valid_time, name='velocity')
return self._velocity_
|
@property
def velocity(self):
if (self._velocity_ is None):
self._velocity_ = _2dCSCG_VectorField(self.mesh, [self.u, self.v], valid_time=self.valid_time, name='velocity')
return self._velocity_<|docstring|>A scalar field of the kinetic energy distribution.<|endoftext|>
|
3ede615a97e900e43e339ef138a8d6ffbea2967abd25ac9f753ed43d6fae00b4
|
@property
def vorticity(self):
'A scalar field of the kinetic energy distribution.'
if (self._vorticity_ is None):
self._vorticity_ = _2dCSCG_ScalarField(self.mesh, self.omega, valid_time=self.valid_time, name='vorticity')
return self._vorticity_
|
A scalar field of the kinetic energy distribution.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
vorticity
|
mathischeap/mifem
| 1 |
python
|
@property
def vorticity(self):
if (self._vorticity_ is None):
self._vorticity_ = _2dCSCG_ScalarField(self.mesh, self.omega, valid_time=self.valid_time, name='vorticity')
return self._vorticity_
|
@property
def vorticity(self):
if (self._vorticity_ is None):
self._vorticity_ = _2dCSCG_ScalarField(self.mesh, self.omega, valid_time=self.valid_time, name='vorticity')
return self._vorticity_<|docstring|>A scalar field of the kinetic energy distribution.<|endoftext|>
|
d0d70b4d3f6a530cfebfe21bdc23e4155d719d0fc530193ea0d893d3dbccaf1e
|
@property
def pressure(self):
'A scalar field of the kinetic energy distribution.'
if (self._pressure_ is None):
self._pressure_ = _2dCSCG_ScalarField(self.mesh, self.p, valid_time=self.valid_time, name='pressure')
return self._pressure_
|
A scalar field of the kinetic energy distribution.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
pressure
|
mathischeap/mifem
| 1 |
python
|
@property
def pressure(self):
if (self._pressure_ is None):
self._pressure_ = _2dCSCG_ScalarField(self.mesh, self.p, valid_time=self.valid_time, name='pressure')
return self._pressure_
|
@property
def pressure(self):
if (self._pressure_ is None):
self._pressure_ = _2dCSCG_ScalarField(self.mesh, self.p, valid_time=self.valid_time, name='pressure')
return self._pressure_<|docstring|>A scalar field of the kinetic energy distribution.<|endoftext|>
|
068434078fc6c1648b254b4a9b6e1fd918a701cbe99b1cd86452a5c2bf03e8cd
|
@property
def total_pressure(self):
'A scalar field of the kinetic energy distribution.'
if (self._total_pressure_ is None):
self._total_pressure_ = _2dCSCG_ScalarField(self.mesh, self._tp_, valid_time=self.valid_time, name='total pressure')
return self._total_pressure_
|
A scalar field of the kinetic energy distribution.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
total_pressure
|
mathischeap/mifem
| 1 |
python
|
@property
def total_pressure(self):
if (self._total_pressure_ is None):
self._total_pressure_ = _2dCSCG_ScalarField(self.mesh, self._tp_, valid_time=self.valid_time, name='total pressure')
return self._total_pressure_
|
@property
def total_pressure(self):
if (self._total_pressure_ is None):
self._total_pressure_ = _2dCSCG_ScalarField(self.mesh, self._tp_, valid_time=self.valid_time, name='total pressure')
return self._total_pressure_<|docstring|>A scalar field of the kinetic energy distribution.<|endoftext|>
|
fdf2d4fb5667fd0508385fea0b1f371e6ca8423b5530722cf2401ee618d3742d
|
@property
def kinetic_energy_distribution(self):
'A scalar field of the kinetic energy distribution.'
if (self._kinetic_energy_distribution_ is None):
self._kinetic_energy_distribution_ = _2dCSCG_ScalarField(self.mesh, self.___kinetic_energy_distribution___, valid_time=self.valid_time, name='kinetic_energy')
return self._kinetic_energy_distribution_
|
A scalar field of the kinetic energy distribution.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
kinetic_energy_distribution
|
mathischeap/mifem
| 1 |
python
|
@property
def kinetic_energy_distribution(self):
if (self._kinetic_energy_distribution_ is None):
self._kinetic_energy_distribution_ = _2dCSCG_ScalarField(self.mesh, self.___kinetic_energy_distribution___, valid_time=self.valid_time, name='kinetic_energy')
return self._kinetic_energy_distribution_
|
@property
def kinetic_energy_distribution(self):
if (self._kinetic_energy_distribution_ is None):
self._kinetic_energy_distribution_ = _2dCSCG_ScalarField(self.mesh, self.___kinetic_energy_distribution___, valid_time=self.valid_time, name='kinetic_energy')
return self._kinetic_energy_distribution_<|docstring|>A scalar field of the kinetic energy distribution.<|endoftext|>
|
878e0a09cf589cf9c65c0220519f717e9d75c3d9b50f26729183fa0b97383e9b
|
@property
def body_force(self):
'A scalar field of the kinetic energy distribution.'
if (self._body_force_ is None):
self._body_force_ = _2dCSCG_VectorField(self.mesh, [self.fx, self.fy], valid_time=self.valid_time, name='body_force')
return self._body_force_
|
A scalar field of the kinetic energy distribution.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
body_force
|
mathischeap/mifem
| 1 |
python
|
@property
def body_force(self):
if (self._body_force_ is None):
self._body_force_ = _2dCSCG_VectorField(self.mesh, [self.fx, self.fy], valid_time=self.valid_time, name='body_force')
return self._body_force_
|
@property
def body_force(self):
if (self._body_force_ is None):
self._body_force_ = _2dCSCG_VectorField(self.mesh, [self.fx, self.fy], valid_time=self.valid_time, name='body_force')
return self._body_force_<|docstring|>A scalar field of the kinetic energy distribution.<|endoftext|>
|
e4b4e680fd196ae0e27feeebe5fa9b1e5f6b2b8e4fce7689fc7cb02c6addc44e
|
@staticmethod
def source_term(t, x, y):
'By default, we have divergence free condition; the source term is zero.'
return (0 * x)
|
By default, we have divergence free condition; the source term is zero.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
source_term
|
mathischeap/mifem
| 1 |
python
|
@staticmethod
def source_term(t, x, y):
return (0 * x)
|
@staticmethod
def source_term(t, x, y):
return (0 * x)<|docstring|>By default, we have divergence free condition; the source term is zero.<|endoftext|>
|
981da0ccb1bdae37c85bac723d6392f868bd65b874d02935fbd78606fa63785c
|
def ___PreFrozenChecker___(self):
'Will be called before freezing self.'
TS = self.___PRIVATE_generate_random_valid_time_instances___()
(x, y) = self._mesh_.do.generate_random_coordinates()
if (len(x) == 0):
return
for t in TS:
try:
fx = (((self.u_t(t, x, y) - (self.omega(t, x, y) * self.v(t, x, y))) + (self.nu * self.omega_y(t, x, y))) + self._tp_x_(t, x, y))
fy = (((self.v_t(t, x, y) + (self.omega(t, x, y) * self.u(t, x, y))) - (self.nu * self.omega_x(t, x, y))) + self._tp_y_(t, x, y))
FX = self.fx(t, x, y)
FY = self.fy(t, x, y)
np.testing.assert_array_almost_equal((FX - fx), 0, decimal=5)
np.testing.assert_array_almost_equal((FY - fy), 0, decimal=5)
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.u, t, x, y)
assert all(Pu.check_total(self.u_t, self.u_x, self.u_y))
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.v, t, x, y)
assert all(Pu.check_total(self.v_t, self.v_x, self.v_y))
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.p, t, x, y)
assert all(Pu.check_total(self.p_t, self.p_x, self.p_y))
except NotImplementedError:
pass
try:
np.testing.assert_array_almost_equal((self.u_x(t, x, y) + self.v_y(t, x, y)), self.source_term(t, x, y), decimal=5)
except NotImplementedError:
pass
|
Will be called before freezing self.
|
objects/CSCG/_2d/exact_solutions/status/incompressible_Navier_Stokes/base.py
|
___PreFrozenChecker___
|
mathischeap/mifem
| 1 |
python
|
def ___PreFrozenChecker___(self):
TS = self.___PRIVATE_generate_random_valid_time_instances___()
(x, y) = self._mesh_.do.generate_random_coordinates()
if (len(x) == 0):
return
for t in TS:
try:
fx = (((self.u_t(t, x, y) - (self.omega(t, x, y) * self.v(t, x, y))) + (self.nu * self.omega_y(t, x, y))) + self._tp_x_(t, x, y))
fy = (((self.v_t(t, x, y) + (self.omega(t, x, y) * self.u(t, x, y))) - (self.nu * self.omega_x(t, x, y))) + self._tp_y_(t, x, y))
FX = self.fx(t, x, y)
FY = self.fy(t, x, y)
np.testing.assert_array_almost_equal((FX - fx), 0, decimal=5)
np.testing.assert_array_almost_equal((FY - fy), 0, decimal=5)
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.u, t, x, y)
assert all(Pu.check_total(self.u_t, self.u_x, self.u_y))
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.v, t, x, y)
assert all(Pu.check_total(self.v_t, self.v_x, self.v_y))
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.p, t, x, y)
assert all(Pu.check_total(self.p_t, self.p_x, self.p_y))
except NotImplementedError:
pass
try:
np.testing.assert_array_almost_equal((self.u_x(t, x, y) + self.v_y(t, x, y)), self.source_term(t, x, y), decimal=5)
except NotImplementedError:
pass
|
def ___PreFrozenChecker___(self):
TS = self.___PRIVATE_generate_random_valid_time_instances___()
(x, y) = self._mesh_.do.generate_random_coordinates()
if (len(x) == 0):
return
for t in TS:
try:
fx = (((self.u_t(t, x, y) - (self.omega(t, x, y) * self.v(t, x, y))) + (self.nu * self.omega_y(t, x, y))) + self._tp_x_(t, x, y))
fy = (((self.v_t(t, x, y) + (self.omega(t, x, y) * self.u(t, x, y))) - (self.nu * self.omega_x(t, x, y))) + self._tp_y_(t, x, y))
FX = self.fx(t, x, y)
FY = self.fy(t, x, y)
np.testing.assert_array_almost_equal((FX - fx), 0, decimal=5)
np.testing.assert_array_almost_equal((FY - fy), 0, decimal=5)
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.u, t, x, y)
assert all(Pu.check_total(self.u_t, self.u_x, self.u_y))
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.v, t, x, y)
assert all(Pu.check_total(self.v_t, self.v_x, self.v_y))
except NotImplementedError:
pass
try:
Pu = NumericalPartialDerivative_txy(self.p, t, x, y)
assert all(Pu.check_total(self.p_t, self.p_x, self.p_y))
except NotImplementedError:
pass
try:
np.testing.assert_array_almost_equal((self.u_x(t, x, y) + self.v_y(t, x, y)), self.source_term(t, x, y), decimal=5)
except NotImplementedError:
pass<|docstring|>Will be called before freezing self.<|endoftext|>
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.