sevenbridges package¶
sevenbridges-python¶
copyright: | 2018 Seven Bridges Genomics Inc. |
---|---|
license: | Apache 2.0 |
-
class
sevenbridges.
Api
(url=None, token=None, oauth_token=None, config=None, timeout=None, download_max_workers=16, upload_max_workers=16, proxies=None, error_handlers=None, advance_access=False)¶ Bases:
sevenbridges.http.client.HttpClient
Api aggregates all resource classes into single place
-
actions
¶ alias of
Actions
-
billing_groups
¶ alias of
BillingGroup
-
rate_limit
¶ alias of
RateLimit
-
teams
¶ alias of
Team
-
-
class
sevenbridges.
Config
(profile=None, proxies=None, advance_access=None)¶ Bases:
object
Utility configuration class.
-
class
sevenbridges.
Invoice
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing invoices.
-
analysis_costs
¶
-
deepcopy
()¶
-
equals
(other)¶
-
href
= None¶
-
id
= None¶
-
invoice_period
¶
-
pending
= None¶
-
classmethod
query
(offset=None, limit=None, api=None)¶ Query (List) invoices. :param offset: Pagination offset. :param limit: Pagination limit. :param api: Api instance. :return: Collection object.
-
storage_costs
¶
-
total
¶
-
-
class
sevenbridges.
BillingGroup
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing billing groups.
-
balance
¶
-
breakdown
()¶ Get Billing group breakdown for the current billing group.
-
deepcopy
()¶
-
disabled
= None¶
-
equals
(other)¶
-
href
= None¶
-
id
= None¶
-
name
= None¶
-
owner
= None¶
-
pending
= None¶
-
classmethod
query
(offset=None, limit=None, api=None)¶ Query (List) billing group. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object. :param api: Api instance.
-
type
= None¶
-
-
class
sevenbridges.
BillingGroupBreakdown
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing billing group breakdowns.
-
deepcopy
()¶
-
equals
(other)¶
-
href
= None¶
-
project_breakdown
¶
-
total_spending
¶
-
-
class
sevenbridges.
User
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing tasks.
-
address
= None¶
-
affiliation
= None¶
-
city
= None¶
-
country
= None¶
-
deepcopy
()¶
-
email
= None¶
-
equals
(other)¶
-
first_name
= None¶
-
classmethod
get
(user, api=None)¶
-
href
= None¶
-
last_name
= None¶
-
classmethod
me
(api=None)¶ Retrieves current user information. :param api: Api instance. :return: User object.
-
phone
= None¶
-
state
= None¶
-
username
= None¶
-
zip_code
= None¶
-
-
class
sevenbridges.
Endpoints
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing Endpoints.
-
action_url
= None¶
-
apps_url
= None¶
-
billing_url
= None¶
-
deepcopy
()¶
-
equals
(other)¶
-
files_url
= None¶
-
classmethod
get
(api=None, **kwargs)¶ Get api links. :param api: Api instance. :return: Endpoints object.
-
projects_url
= None¶
-
rate_limit_url
= None¶
-
tasks_url
= None¶
-
upload_url
= None¶
-
user_url
= None¶
-
users_url
= None¶
-
-
class
sevenbridges.
Project
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing projects.
-
add_files
(files)¶ Adds files to this project. :param files: List of files or a Collection object.
-
add_member
(user, permissions)¶ Add a member to the project. :param user: Member username :param permissions: Permissions dictionary. :return: Member object.
-
add_member_division
(division, permissions)¶ Add a member (team) to a project. :param division: Division object or division identifier. :param permissions: Permissions dictionary. :return: Member object.
-
add_member_email
(email, permissions=None)¶ Add a member to the project using member email. :param email: Member email. :param permissions: Permissions dictionary. :return: Member object.
-
add_member_team
(team, permissions)¶ Add a member (team) to a project. :param team: Team object or team identifier. :param permissions: Permissions dictionary. :return: Member object.
-
billing_group
= None¶
-
classmethod
create
(name, billing_group=None, description=None, tags=None, settings=None, api=None)¶ Create a project. :param name: Project name. :param billing_group: Project billing group. :param description: Project description. :param tags: Project tags. :param settings: Project settings. :param api: Api instance. :return:
-
create_task
(name, app, revision=None, batch_input=None, batch_by=None, inputs=None, description=None, run=False, disable_batch=False, interruptible=True)¶ Creates a task for this project.
Parameters: - name – Task name.
- app – CWL app identifier.
- revision – CWL app revision.
- batch_input – Batch input.
- batch_by – Batch criteria.
- inputs – Input map.
- description – Task description.
- run – True if you want to run a task upon creation.
- disable_batch – True if you want to disable batching.
- interruptible – True if you want to use interruptible instances.
Returns: Task object.
-
deepcopy
()¶
-
description
= None¶
-
equals
(other)¶
-
get_apps
(offset=None, limit=None)¶ Retrieves apps in this project. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_exports
(volume=None, state=None, offset=None, limit=None)¶ Fetches exports for this volume. :param volume: Optional volume identifier. :param state: Optional state. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_files
(offset=None, limit=None)¶ Retrieves files in this project. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_imports
(volume=None, state=None, offset=None, limit=None)¶ Fetches imports for this project. :param volume: Optional volume identifier. :param state: Optional state. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_members
(offset=None, limit=None)¶ Retrieves project members. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_tasks
(status=None, offset=None, limit=None)¶ Retrieves tasks in this project. :param status: Optional task status. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
href
= None¶
-
id
= None¶
-
name
= None¶
-
classmethod
query
(owner=None, offset=None, limit=None, api=None)¶ Query (List) projects :param owner: Owner username. :param offset: Pagination offset. :param limit: Pagination limit. :param api: Api instance. :return: Collection object.
-
remove_member
(user)¶ Remove member from the project. :param user: User to be removed.
-
save
(obj, *args, **kwargs)¶
-
settings
¶
-
type
= None¶
-
-
class
sevenbridges.
Task
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing tasks.
-
abort
(obj, *args, **kwargs)¶
-
app
= None¶
-
batch
= None¶
-
batch_by
¶
-
batch_group
¶
-
batch_input
= None¶
-
classmethod
create
(name, project, app, revision=None, batch_input=None, batch_by=None, inputs=None, description=None, run=False, disable_batch=False, interruptible=True, api=None)¶ Creates a task on server. :param name: Task name. :param project: Project identifier. :param app: CWL app identifier. :param revision: CWL app revision. :param batch_input: Batch input. :param batch_by: Batch criteria. :param inputs: Input map. :param description: Task description. :param run: True if you want to run a task upon creation. :param disable_batch: If True disables batching of a batch task. :param interruptible: If True interruptible instance will be used. :param api: Api instance. :return: Task object. :raises: TaskValidationError if validation Fails. :raises: SbgError if any exception occurs during request.
-
created_by
= None¶
-
created_time
= None¶
-
deepcopy
()¶
-
description
= None¶
-
end_time
= None¶
-
equals
(other)¶
-
errors
= None¶
-
executed_by
= None¶
-
execution_status
¶
-
get_batch_children
()¶ Retrieves batch child tasks for this task if its a batch task. :return: Collection instance. :raises SbError if task is not a batch task.
-
get_execution_details
()¶ Retrieves execution details for a task. :return: Execution details instance.
-
href
= None¶
-
id
= None¶
-
inputs
¶
-
name
= None¶
-
outputs
¶
-
parent
= None¶
-
price
¶
-
project
= None¶
-
classmethod
query
(project=None, status=None, batch=None, parent=None, created_from=None, created_to=None, started_from=None, started_to=None, ended_from=None, ended_to=None, offset=None, limit=None, api=None)¶ Query (List) tasks. Date parameters may be both strings and python date objects. :param project: Target project. optional. :param status: Task status. :param batch: Only batch tasks. :param parent: Parent batch task identifier. :param ended_to: All tasks that ended until this date. :param ended_from: All tasks that ended from this date. :param started_to: All tasks that were started until this date. :param started_from: All tasks that were started from this date. :param created_to: All tasks that were created until this date. :param created_from: All tasks that were created from this date. :param offset: Pagination offset. :param limit: Pagination limit. :param api: Api instance. :return: Collection object.
-
run
(obj, *args, **kwargs)¶
-
save
(obj, *args, **kwargs)¶
-
start_time
= None¶
-
status
= None¶
-
type
= None¶
-
use_interruptible_instances
= None¶
-
warnings
= None¶
-
-
class
sevenbridges.
App
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing apps.
-
copy
(project, name=None)¶ Copies the current app. :param project: Destination project. :param name: Destination app name. :return: Copied App object.
-
classmethod
create_revision
(id, revision, raw, api=None)¶ Create a new app revision. :param id: App identifier. :param revision: App revision. :param raw: Raw cwl object. :param api: Api instance. :return: App object.
-
deepcopy
()¶
-
equals
(other)¶
-
classmethod
get_revision
(id, revision, api=None)¶ Get app revision. :param id: App identifier. :param revision: App revision :param api: Api instance. :return: App object.
-
href
= None¶
-
id
¶
-
classmethod
install_app
(id, raw, api=None, raw_format=None)¶ Installs and app. :param id: App identifier. :param raw: Raw cwl data. :param api: Api instance. :param raw_format: Format of raw app data being sent, json by default :return: App object.
-
name
= None¶
-
project
= None¶
-
classmethod
query
(project=None, visibility=None, q=None, id=None, offset=None, limit=None, api=None)¶ Query (List) apps. :param project: Source project. :param visibility: private|public for private or public apps. :param q: List containing search terms. :param id: List contains app ids. Fetch apps with specific ids. :param offset: Pagination offset. :param limit: Pagination limit. :param api: Api instance. :return: collection object
-
raw
= None¶
-
revision
= None¶
-
sync
()¶ Syncs the parent app changes with the current app instance. :return: Synced App object.
-
-
class
sevenbridges.
Member
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing members. This resource is reused on both projects and volumes.
-
deepcopy
()¶
-
email
= None¶
-
equals
(other)¶
-
href
= None¶
-
id
= None¶
-
permissions
¶
-
save
(obj, *args, **kwargs)¶
-
type
= None¶
-
username
= None¶
-
-
class
sevenbridges.
Permissions
(**kwargs)¶ Bases:
sevenbridges.meta.comp_mutable_dict.CompoundMutableDict
,sevenbridges.meta.resource.Resource
Members permissions resource.
-
class
sevenbridges.
File
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing files.
-
classmethod
bulk_delete
(files, api=None)¶ Delete files with specified ids in bulk :param files: Files to be deleted. :param api: Api instance. :return: List of FileBulkRecord objects.
-
classmethod
bulk_edit
(files, api=None)¶ Edit files with specified ids in bulk :param files: Files to be updated. :param api: Api instance. :return: List of FileBulkRecord objects.
-
classmethod
bulk_get
(files, api=None)¶ Retrieve files with specified ids in bulk :param files: Files to be retrieved. :param api: Api instance. :return: List of FileBulkRecord objects.
-
classmethod
bulk_update
(files, api=None)¶ Update files with specified ids in bulk :param files: Files to be updated. :param api: Api instance. :return: List of FileBulkRecord objects.
-
content
(path=None, overwrite=True, encoding='utf-8')¶ Downloads file to the specified path or as temporary file and reads the file content in memory.
Should not be used on very large files.Parameters: - path – Path for file download If omitted tmp file will be used.
- overwrite – Overwrite file if exists locally
- encoding – File encoding, by default it is UTF-8
Returns: File content.
-
copy
(project, name=None)¶ Copies the current file. :param project: Destination project. :param name: Destination file name. :return: Copied File object.
-
created_on
= None¶
-
deepcopy
()¶
-
download
(path, retry=5, timeout=10, chunk_size=5242880, wait=True, overwrite=False)¶ Downloads the file and returns a download handle. Download will not start until .start() method is invoked. :param path: Full path to the new file. :param retry: Number of retries if error occurs during download. :param timeout: Timeout for http requests. :param chunk_size: Chunk size in bytes. :param wait: If true will wait for download to complete. :param overwrite: If True will silently overwrite existing file. :return: Download handle.
-
download_info
()¶ Fetches download information containing file url that can be used to download file. :return: Download info object.
-
equals
(other)¶
-
href
= None¶
-
id
= None¶
-
metadata
¶
-
modified_on
= None¶
-
name
= None¶
-
origin
¶
-
project
= None¶
-
classmethod
query
(project, names=None, metadata=None, origin=None, tags=None, offset=None, limit=None, api=None)¶ Query ( List ) projects :param project: Project id :param names: Name list :param metadata: Metadata query dict :param origin: Origin query dict :param tags: List of tags to filter on :param offset: Pagination offset :param limit: Pagination limit :param api: Api instance. :return: Collection object.
-
reload
()¶ Refreshes the file with the data from the server.
-
save
(obj, *args, **kwargs)¶
-
size
= None¶
-
storage
¶
-
stream
(part_size=32768)¶ Creates an iterator which can be used to stream the file content. :param part_size: Size of the part in bytes. Default 32KB :return Iterator
-
classmethod
upload
(path, project, file_name=None, overwrite=False, retry=5, timeout=10, part_size=5242880, wait=True, api=None)¶ Uploads a file using multipart upload and returns an upload handle if the wait parameter is set to False. If wait is set to True it will block until the upload is completed.
Parameters: - path – File path on local disc.
- project – Project identifier
- file_name – Optional file name.
- overwrite – If true will overwrite the file on the server.
- retry – Number of retries if error occurs during upload.
- timeout – Timeout for http requests.
- part_size – Part size in bytes.
- wait – If true will wait for upload to complete.
- api – Api instance.
-
classmethod
-
class
sevenbridges.
Export
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing exports.
-
classmethod
bulk_get
(exports, api=None)¶ Retrieve exports in bulk. :param exports: Exports to be retrieved. :param api: Api instance. :return: list of ExportBulkRecord objects.
-
classmethod
bulk_submit
(exports, api=None)¶ Create exports in bulk. :param exports: Exports to be submitted in bulk. :param api: Api instance. :return: list of ExportBulkRecord objects.
-
deepcopy
()¶
-
destination
¶
-
equals
(other)¶
-
error
¶
-
finished_on
= None¶
-
href
= None¶
-
id
= None¶
-
overwrite
= None¶
-
properties
¶
-
classmethod
query
(volume=None, state=None, offset=None, limit=None, api=None)¶ Query (List) exports. :param volume: Optional volume identifier. :param state: Optional import sate. :param api: Api instance. :return: Collection object.
-
result
¶
-
source
¶
-
started_on
= None¶
-
state
= None¶
-
classmethod
submit_export
(file, volume, location, properties=None, overwrite=False, copy_only=False, api=None)¶ Submit new export job. :param file: File to be exported. :param volume: Volume identifier. :param location: Volume location. :param properties: Properties dictionary. :param overwrite: If true it will overwrite file if exists :param copy_only: If true files are kept on SevenBridges bucket. :param api: Api Instance. :return: Export object.
-
classmethod
-
class
sevenbridges.
Import
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing imports.
-
classmethod
bulk_get
(imports, api=None)¶ Retrieve imports in bulk :param imports: Imports to be retrieved. :param api: Api instance. :return: List of ImportBulkRecord objects.
-
classmethod
bulk_submit
(imports, api=None)¶ Submit imports in bulk :param imports: Imports to be retrieved. :param api: Api instance. :return: List of ImportBulkRecord objects.
-
deepcopy
()¶
-
destination
¶
-
equals
(other)¶
-
error
¶
-
finished_on
= None¶
-
href
= None¶
-
id
= None¶
-
overwrite
= None¶
-
classmethod
query
(project=None, volume=None, state=None, offset=None, limit=None, api=None)¶ Query (List) imports. :param project: Optional project identifier. :param volume: Optional volume identifier. :param state: Optional import sate. :param api: Api instance. :return: Collection object.
-
result
¶
-
source
¶
-
started_on
= None¶
-
state
= None¶
-
classmethod
submit_import
(volume, location, project, name=None, overwrite=False, properties=None, api=None)¶ Submits new import job. :param volume: Volume identifier. :param location: Volume location. :param project: Project identifier. :param name: Optional file name. :param overwrite: If true it will overwrite file if exists. :param properties: Properties dictionary. :param api: Api instance. :return: Import object.
-
classmethod
-
class
sevenbridges.
Volume
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing volumes.
-
access_mode
= None¶
-
active
= None¶
-
add_member
(user, permissions)¶ Add a member to the volume. :param user: Member username :param permissions: Permissions dictionary. :return: Member object.
-
add_member_division
(division, permissions)¶ Add a member (team) to a volume. :param division: Division object or division identifier. :param permissions: Permissions dictionary. :return: Member object.
-
add_member_team
(team, permissions)¶ Add a member (team) to a volume. :param team: Team object or team identifier. :param permissions: Permissions dictionary. :return: Member object.
-
classmethod
create_google_volume
(name, bucket, client_email, private_key, access_mode, description=None, prefix=None, properties=None, api=None)¶ Create s3 volume. :param name: Volume name. :param bucket: Referenced bucket. :param client_email: Google client email. :param private_key: Google client private key. :param access_mode: Access Mode. :param description: Volume description. :param prefix: Volume prefix. :param properties: Volume properties. :param api: Api instance. :return: Volume object.
-
classmethod
create_s3_volume
(name, bucket, access_key_id, secret_access_key, access_mode, description=None, prefix=None, properties=None, api=None)¶ Create s3 volume. :param name: Volume name. :param bucket: Referenced bucket. :param access_key_id: Amazon access key identifier. :param secret_access_key: Amazon secret access key. :param access_mode: Access Mode. :param description: Volume description. :param prefix: Volume prefix. :param properties: Volume properties. :param api: Api instance. :return: Volume object.
-
created_on
= None¶
-
deepcopy
()¶
-
description
= None¶
-
equals
(other)¶
-
get_exports
(state=None, offset=None, limit=None)¶ Fetches exports for this volume. :param state: Optional state. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_imports
(project=None, state=None, offset=None, limit=None)¶ Fetches imports for this volume. :param project: Optional project identifier. :param state: Optional state. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_members
(offset=None, limit=None)¶ Retrieves volume members. :param offset: Pagination offset. :param limit: Pagination limit. :return: Collection object.
-
get_volume_object_info
(location)¶ Fetches information about single volume object - usually file :param location: object location :return:
-
href
= None¶
-
id
= None¶
-
list
(prefix=None, limit=50)¶
-
modified_on
= None¶
-
name
= None¶
-
classmethod
query
(offset=None, limit=None, api=None)¶ Query (List) volumes. :param offset: Pagination offset. :param limit: Pagination limit. :param api: Api instance. :return: Collection object.
-
remove_member
(user)¶ Remove member from the volume. :param user: User to be removed.
-
save
(obj, *args, **kwargs)¶
-
service
¶
-
-
class
sevenbridges.
Marker
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
-
chromosome
= None¶
-
classmethod
create
(file, name, position, chromosome, private=True, api=None)¶ Create a marker on a file. :param file: File object or identifier. :param name: Marker name. :param position: Marker position object. :param chromosome: Chromosome number. :param private: Whether the marker is private or public. :param api: Api instance. :return: Marker object.
-
created_by
= None¶
-
created_time
= None¶
-
deepcopy
()¶
-
delete
()¶
-
equals
(other)¶
-
file
= None¶
-
href
= None¶
-
id
= None¶
-
name
= None¶
-
position
¶
-
classmethod
query
(file, offset=None, limit=None, api=None)¶ Queries genome markers on a file. :param file: Genome file - Usually bam file. :param offset: Pagination offset. :param limit: Pagination limit. :param api: Api instance. :return: Collection object.
-
reload
()¶
-
save
(obj, *args, **kwargs)¶
-
-
class
sevenbridges.
Division
(**kwargs)¶ Bases:
sevenbridges.meta.resource.Resource
Central resource for managing divisions.
-
deepcopy
()¶
-
equals
(other)¶
-
classmethod
get
(id, api=None)¶
-
get_teams
(offset=None, limit=None)¶
-
href
= None¶
-
id
= None¶
-
name
= None¶
-
classmethod
query
(offset=None, limit=None, api=None)¶ Query (List) divisions.
Parameters: - offset – Pagination offset.
- limit – Pagination limit.
- api – Api instance.
Returns: Collection object.
-
reload
()¶
-
-
class
sevenbridges.
TransferState
¶ Bases:
object
-
ABORTED
= 'ABORTED'¶
-
COMPLETED
= 'COMPLETED'¶
-
FAILED
= 'FAILED'¶
-
PAUSED
= 'PAUSED'¶
-
PREPARING
= 'PREPARING'¶
-
RUNNING
= 'RUNNING'¶
-
STOPPED
= 'STOPPED'¶
-
-
class
sevenbridges.
ImportExportState
¶ Bases:
object
-
COMPLETED
= 'COMPLETED'¶
-
FAILED
= 'FAILED'¶
-
PENDING
= 'PENDING'¶
-
RUNNING
= 'RUNNING'¶
-
-
class
sevenbridges.
TaskStatus
¶ Bases:
object
-
ABORTED
= 'ABORTED'¶
-
COMPLETED
= 'COMPLETED'¶
-
CREATING
= 'CREATING'¶
-
DRAFT
= 'DRAFT'¶
-
FAILED
= 'FAILED'¶
-
QUEUED
= 'QUEUED'¶
-
RUNNING
= 'RUNNING'¶
-
-
exception
sevenbridges.
SbgError
(message=None, code=None, status=None, more_info=None)¶ Bases:
Exception
Base class for SBG errors.
Provides a base exception for all errors that are thrown by sevenbridges-python library.
-
exception
sevenbridges.
ResourceNotModified
¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
ReadOnlyPropertyError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
ValidationError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
TaskValidationError
(message, task=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
PaginationError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
BadRequest
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
Forbidden
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
NotFound
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
Conflict
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
TooManyRequests
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
ServerError
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
MethodNotAllowed
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
RequestTimeout
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
LocalFileAlreadyExists
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.
ExecutionDetailsInvalidTaskType
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Subpackages¶
- sevenbridges.http package
- sevenbridges.meta package
- sevenbridges.models package
- Subpackages
- sevenbridges.models.compound package
- Subpackages
- sevenbridges.models.compound.billing package
- sevenbridges.models.compound.files package
- sevenbridges.models.compound.jobs package
- sevenbridges.models.compound.limits package
- sevenbridges.models.compound.markers package
- sevenbridges.models.compound.projects package
- sevenbridges.models.compound.tasks package
- sevenbridges.models.compound.volumes package
- Submodules
- sevenbridges.models.compound.volumes.import_destination module
- sevenbridges.models.compound.volumes.properties module
- sevenbridges.models.compound.volumes.service module
- sevenbridges.models.compound.volumes.volume_file module
- sevenbridges.models.compound.volumes.volume_object module
- sevenbridges.models.compound.volumes.volume_prefix module
- Submodules
- sevenbridges.models.compound.error module
- sevenbridges.models.compound.price module
- sevenbridges.models.compound.price_breakdown module
- Subpackages
- sevenbridges.models.compound package
- Submodules
- sevenbridges.models.actions module
- sevenbridges.models.app module
- sevenbridges.models.billing_breakdown module
- sevenbridges.models.billing_group module
- sevenbridges.models.division module
- sevenbridges.models.endpoints module
- sevenbridges.models.enums module
- sevenbridges.models.execution_details module
- sevenbridges.models.file module
- sevenbridges.models.invoice module
- sevenbridges.models.link module
- sevenbridges.models.marker module
- sevenbridges.models.member module
- sevenbridges.models.project module
- sevenbridges.models.rate_limit module
- sevenbridges.models.storage_export module
- sevenbridges.models.storage_import module
- sevenbridges.models.task module
- sevenbridges.models.team module
- sevenbridges.models.team_member module
- sevenbridges.models.user module
- sevenbridges.models.volume module
- Subpackages
- sevenbridges.transfer package
Submodules¶
sevenbridges.api module¶
-
class
sevenbridges.api.
Api
(url=None, token=None, oauth_token=None, config=None, timeout=None, download_max_workers=16, upload_max_workers=16, proxies=None, error_handlers=None, advance_access=False)¶ Bases:
sevenbridges.http.client.HttpClient
Api aggregates all resource classes into single place
-
actions
¶ alias of
Actions
-
apps
¶ alias of
App
-
billing_groups
¶ alias of
BillingGroup
-
divisions
¶ alias of
Division
-
endpoints
¶ alias of
Endpoints
-
exports
¶ alias of
Export
-
files
¶ alias of
File
-
imports
¶ alias of
Import
-
invoices
¶ alias of
Invoice
-
markers
¶ alias of
Marker
-
projects
¶ alias of
Project
-
rate_limit
¶ alias of
RateLimit
-
tasks
¶ alias of
Task
-
teams
¶ alias of
Team
-
users
¶ alias of
User
-
volumes
¶ alias of
Volume
-
sevenbridges.config module¶
-
class
sevenbridges.config.
Config
(profile=None, proxies=None, advance_access=None)¶ Bases:
object
Utility configuration class.
-
class
sevenbridges.config.
Profile
(profile)¶ Bases:
object
-
CONFIG
= '/home/docs/.sevenbridges/sevenbridges-python/config'¶
-
CREDENTIALS
= '/home/docs/.sevenbridges/credentials'¶
-
advance_access
¶
-
api_endpoint
¶
-
auth_token
¶
-
proxies
¶
-
-
sevenbridges.config.
format_proxies
(proxies)¶ Helper method for request proxy key compatibility. :param proxies: Proxies dictionary :return: Dict compatible with request proxy format.
sevenbridges.decorators module¶
-
sevenbridges.decorators.
check_for_error
(func)¶ Executes the wrapped function and inspects the response object for specific errors.
-
sevenbridges.decorators.
inplace_reload
(method)¶ Executes the wrapped function and reloads the object with data returned from the server.
-
sevenbridges.decorators.
retry
(retry_count)¶ Retry decorator used during file upload and download.
-
sevenbridges.decorators.
retry_on_excs
(excs, retry_count=3, delay=5)¶ Retry decorator used to retry callables on for specific exceptions.
Parameters: - excs – Exceptions tuple.
- retry_count – Retry count.
- delay – Delay in seconds between retries.
Returns: Wrapped function object.
sevenbridges.errors module¶
-
exception
sevenbridges.errors.
AdvanceAccessError
(message=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
BadRequest
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
Conflict
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ExecutionDetailsInvalidTaskType
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
Forbidden
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
LocalFileAlreadyExists
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
MethodNotAllowed
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
NotFound
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
PaginationError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ReadOnlyPropertyError
(message)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
RequestTimeout
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ResourceNotModified
¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
SbgError
(message=None, code=None, status=None, more_info=None)¶ Bases:
Exception
Base class for SBG errors.
Provides a base exception for all errors that are thrown by sevenbridges-python library.
-
exception
sevenbridges.errors.
ServerError
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
TaskValidationError
(message, task=None)¶ Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
TooManyRequests
(code=None, message=None, more_info=None)¶ Bases:
sevenbridges.errors.SbgError
Bases:
sevenbridges.errors.SbgError
-
exception
sevenbridges.errors.
ValidationError
(message)¶ Bases:
sevenbridges.errors.SbgError