Skip to content

libica.openapi.libgds

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The libica.openapi.libgds package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build date: 2024-07-26T11:42:24.937143+10:00[Australia/Melbourne]
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.15
  • six >= 1.10
  • certifi
  • python-dateutil

Getting Started

In your own code, to use this library to connect and interact with libica.openapi.libgds, you can run the following:

from __future__ import print_function

import time
import libica.openapi.libgds
from libica.openapi.libgds.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libgds.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'


# Enter a context with an instance of the API client
with libica.openapi.libgds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libgds.FilesApi(api_client)
    file_id = 'file_id_example' # str | Unique identifier for the file to be archived.
body = libica.openapi.libgds.FileArchiveRequest() # FileArchiveRequest | 

    try:
        # Archive a file
        api_response = api_instance.archive_file(file_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FilesApi->archive_file: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://aps2.platform.illumina.com

Class Method HTTP request Description
FilesApi archive_file POST /v1/files/{fileId}:archive Archive a file
FilesApi bulk_file_update PATCH /v1/files Updates list of files with metadata
FilesApi complete_file_upload POST /v1/files/{fileId}:completeUpload Complete a file Upload
FilesApi copy_files POST /v1/files/copy Copy list of files
FilesApi create_file POST /v1/files Create a file entry in GDS and get temporary credentials for upload
FilesApi delete_file DELETE /v1/files/{fileId} Permanently delete a file
FilesApi get_file GET /v1/files/{fileId} Get details about a file, including a pre-signed URL for download
FilesApi list_files GET /v1/files Get a list of files
FilesApi list_volume_files POST /v1/files/list Get a list of volume files
FilesApi move_files POST /v1/files/move Move list of files
FilesApi unarchive_file POST /v1/files/{fileId}:unarchive Unarchive a file
FilesApi update_file PATCH /v1/files/{fileId} Update a file entry in GDS and get temporary credentials for upload
FoldersApi archive_folder POST /v1/folders/{folderId}:archive Archive a folder
FoldersApi bulk_folder_update PATCH /v1/folders Updates list of folders with metadata
FoldersApi bulk_metadata_folder_update PATCH /v1/folders/bulkMetadataFolderUpdate Updates list of folders with metadata
FoldersApi complete_folder_session POST /v1/folders/{folderId}/sessions/{sessionId}:complete Complete a folder upload in GDS
FoldersApi copy_folder POST /v1/folders/{folderId}:copy Copy a folder
FoldersApi create_folder POST /v1/folders Create a folder in GDS and receive credentials for upload
FoldersApi create_folder_session POST /v1/folders/{folderId}/sessions Create a session
FoldersApi delete_folder DELETE /v1/folders/{folderId} Deletes a folder by id
FoldersApi get_folder GET /v1/folders/{folderId} Get information about a folder in GDS.
FoldersApi get_folder_job GET /v1/folders/{folderId}/jobs/{jobId} Get status of a folder job in GDS
FoldersApi get_folder_session GET /v1/folders/{folderId}/sessions/{sessionId} Get status of a folder upload in GDS
FoldersApi list_folders GET /v1/folders Get a list of folders
FoldersApi move_folder POST /v1/folders/{folderId}:move Move a folder
FoldersApi unarchive_folder POST /v1/folders/{folderId}:unarchive Unarchive a folder
FoldersApi update_folder PATCH /v1/folders/{folderId} Update a folder content or acl
JobsApi abort_job POST /v1/jobs/{jobId}:abort Abort a job in GDS.
JobsApi get_job GET /v1/jobs/{jobId} Get information about a job in GDS.
JobsApi list_jobs GET /v1/jobs Get a list of jobs for a given folder
VolumeConfigurationsApi create_volume_configuration POST /v1/volumeconfigurations Create a volume configuration in GDS.
VolumeConfigurationsApi delete_volume_configuration DELETE /v1/volumeconfigurations/{volumeConfigurationName} Deletes a volume configuration by Id or name
VolumeConfigurationsApi get_volume_configuration GET /v1/volumeconfigurations/{volumeConfigurationName} Get information for the specified volume configuration name or Id
VolumeConfigurationsApi list_volume_configurations GET /v1/volumeconfigurations Get a list of volumes
VolumeConfigurationsApi validate_volume_configuration POST /v1/volumeconfigurations/{volumeConfigurationName}:validate Validate a volume configuration
VolumesApi create_volume POST /v1/volumes Create a volume in GDS and receive temporary credentials for upload
VolumesApi delete_volume DELETE /v1/volumes/{volumeId} Deletes a volume by Id
VolumesApi get_volume GET /v1/volumes/{volumeId} Get information for the specified volume ID or volume name
VolumesApi list_volumes GET /v1/volumes Get a list of volumes
VolumesApi update_volume PATCH /v1/volumes/{volumeId} Update a volume content

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author