Table of Contents - bio-basespace-sdk-0.1.7 Documentation
Pages
-
README
- BaseSpace Ruby SDK
- Availability and Installation
- Pre-Release Version
- Getting Started
- Application Triggering
- BaseSpace Authentication
- Requesting Access Privileges
- Browsing Data
- Accessing and Querying Files
- Accessing Files
- Querying BAM and VCF Files
- Creating an AppResult and Uploading Files
- Creating an AppResult
- Uploading Files
- Cookbook of Usage Recipes
- Filtering File-Lists and AppResult-Lists using Query Parameter Dictionaries
- Feature Requests and Bug Reporting
- SDK Development Manual
- Building a New Version of the Gem
- Unit Testing
- Porting
- Authors and Contributors
- Authors
- Contributors
- Copying and License
Classes and Modules
- Bio
- Bio::BaseSpace
- Bio::BaseSpace::APIClient
- Bio::BaseSpace::AppResult
- Bio::BaseSpace::AppResultResponse
- Bio::BaseSpace::AppSession
- Bio::BaseSpace::AppSessionCompact
- Bio::BaseSpace::AppSessionLaunchObject
- Bio::BaseSpace::AppSessionResponse
- Bio::BaseSpace::Application
- Bio::BaseSpace::ApplicationCompact
- Bio::BaseSpace::BaseAPI
- Bio::BaseSpace::BaseSpaceAPI
- Bio::BaseSpace::BaseSpaceModel
- Bio::BaseSpace::BillingAPI
- Bio::BaseSpace::Consumer
- Bio::BaseSpace::Coverage
- Bio::BaseSpace::CoverageMetaResponse
- Bio::BaseSpace::CoverageMetadata
- Bio::BaseSpace::CoverageResponse
- Bio::BaseSpace::File
- Bio::BaseSpace::FileResponse
- Bio::BaseSpace::GenomeResponse
- Bio::BaseSpace::GenomeV1
- Bio::BaseSpace::IllegalParameterError
- Bio::BaseSpace::ListResponse
- Bio::BaseSpace::Model
- Bio::BaseSpace::ModelNotInitializedError
- Bio::BaseSpace::MultipartUpload
- Bio::BaseSpace::NoResponseError
- Bio::BaseSpace::Product
- Bio::BaseSpace::Project
- Bio::BaseSpace::ProjectResponse
- Bio::BaseSpace::Purchase
- Bio::BaseSpace::PurchaseResponse
- Bio::BaseSpace::PurchasedProduct
- Bio::BaseSpace::QueryParameters
- Bio::BaseSpace::QueryParametersPurchasedProduct
- Bio::BaseSpace::RefundPurchaseResponse
- Bio::BaseSpace::ResourceList
- Bio::BaseSpace::ResponseStatus
- Bio::BaseSpace::RunCompact
- Bio::BaseSpace::Sample
- Bio::BaseSpace::SampleResponse
- Bio::BaseSpace::UndefinedParameterError
- Bio::BaseSpace::UnknownParameterError
- Bio::BaseSpace::UploadTask
- Bio::BaseSpace::User
- Bio::BaseSpace::UserCompact
- Bio::BaseSpace::UserResponse
- Bio::BaseSpace::Variant
- Bio::BaseSpace::VariantHeader
- Bio::BaseSpace::VariantInfo
- Bio::BaseSpace::VariantsHeaderResponse
- Bio::BaseSpace::WrongFiletypeError
Methods
- ::load_credentials — Bio::BaseSpace
- ::new — Bio::BaseSpace::APIClient
- ::new — Bio::BaseSpace::BaseAPI
- ::new — Bio::BaseSpace::BaseSpaceAPI
- ::new — Bio::BaseSpace::UndefinedParameterError
- ::new — Bio::BaseSpace::UnknownParameterError
- ::new — Bio::BaseSpace::IllegalParameterError
- ::new — Bio::BaseSpace::WrongFiletypeError
- ::new — Bio::BaseSpace::NoResponseError
- ::new — Bio::BaseSpace::ModelNotInitializedError
- ::new — Bio::BaseSpace::BillingAPI
- ::new — Bio::BaseSpace::Model
- ::new — Bio::BaseSpace::AppResult
- ::new — Bio::BaseSpace::AppResultResponse
- ::new — Bio::BaseSpace::AppSession
- ::new — Bio::BaseSpace::AppSessionCompact
- ::new — Bio::BaseSpace::AppSessionLaunchObject
- ::new — Bio::BaseSpace::AppSessionResponse
- ::new — Bio::BaseSpace::Application
- ::new — Bio::BaseSpace::ApplicationCompact
- ::new — Bio::BaseSpace::BaseSpaceModel
- ::new — Bio::BaseSpace::Coverage
- ::new — Bio::BaseSpace::CoverageMetaResponse
- ::new — Bio::BaseSpace::CoverageMetadata
- ::new — Bio::BaseSpace::CoverageResponse
- ::new — Bio::BaseSpace::File
- ::new — Bio::BaseSpace::FileResponse
- ::new — Bio::BaseSpace::GenomeResponse
- ::new — Bio::BaseSpace::GenomeV1
- ::new — Bio::BaseSpace::ListResponse
- ::new — Bio::BaseSpace::UploadTask
- ::new — Bio::BaseSpace::Consumer
- ::new — Bio::BaseSpace::MultipartUpload
- ::new — Bio::BaseSpace::Product
- ::new — Bio::BaseSpace::Project
- ::new — Bio::BaseSpace::ProjectResponse
- ::new — Bio::BaseSpace::Purchase
- ::new — Bio::BaseSpace::PurchaseResponse
- ::new — Bio::BaseSpace::PurchasedProduct
- ::new — Bio::BaseSpace::QueryParameters
- ::new — Bio::BaseSpace::QueryParametersPurchasedProduct
- ::new — Bio::BaseSpace::RefundPurchaseResponse
- ::new — Bio::BaseSpace::ResourceList
- ::new — Bio::BaseSpace::ResponseStatus
- ::new — Bio::BaseSpace::RunCompact
- ::new — Bio::BaseSpace::Sample
- ::new — Bio::BaseSpace::SampleResponse
- ::new — Bio::BaseSpace::User
- ::new — Bio::BaseSpace::UserCompact
- ::new — Bio::BaseSpace::UserResponse
- ::new — Bio::BaseSpace::Variant
- ::new — Bio::BaseSpace::VariantHeader
- ::new — Bio::BaseSpace::VariantInfo
- ::new — Bio::BaseSpace::VariantsHeaderResponse
- ::start — Bio::BaseSpace::BaseSpaceAPI
- #__cleanUp__ — Bio::BaseSpace::MultipartUpload
- #app_result_file_upload — Bio::BaseSpace::BaseSpaceAPI
- #bool — Bio::BaseSpace::APIClient
- #call — Bio::BaseSpace::UploadTask
- #call_api — Bio::BaseSpace::APIClient
- #can_work_on — Bio::BaseSpace::AppSession
- #convert_to_object_list — Bio::BaseSpace::ListResponse
- #create_app_result — Bio::BaseSpace::BaseSpaceAPI
- #create_app_result — Bio::BaseSpace::Project
- #create_project — Bio::BaseSpace::BaseSpaceAPI
- #create_purchase — Bio::BaseSpace::BillingAPI
- #delete_file — Bio::BaseSpace::File
- #deserialize — Bio::BaseSpace::APIClient
- #download_file — Bio::BaseSpace::File
- #file_download — Bio::BaseSpace::BaseSpaceAPI
- #file_url — Bio::BaseSpace::BaseSpaceAPI
- #filter_variant — Bio::BaseSpace::File
- #filter_variant_set — Bio::BaseSpace::BaseSpaceAPI
- #finalize — Bio::BaseSpace::MultipartUpload
- #force_post_call — Bio::BaseSpace::APIClient
- #getFileResponse — Bio::BaseSpace::MultipartUpload
- #getProgressRatio — Bio::BaseSpace::MultipartUpload
- #getRunningThreadCount — Bio::BaseSpace::MultipartUpload
- #getRunningTime — Bio::BaseSpace::MultipartUpload
- #getStatus — Bio::BaseSpace::MultipartUpload
- #getTotalTransfered — Bio::BaseSpace::MultipartUpload
- #getTransRate — Bio::BaseSpace::MultipartUpload
- #get_access — Bio::BaseSpace::BaseSpaceAPI
- #get_access_str — Bio::BaseSpace::AppResult
- #get_access_str — Bio::BaseSpace::Project
- #get_access_str — Bio::BaseSpace::RunCompact
- #get_access_str — Bio::BaseSpace::Sample
- #get_access_token — Bio::BaseSpace::BaseAPI
- #get_accessible_runs_by_user — Bio::BaseSpace::BaseSpaceAPI
- #get_app_result_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_app_result_files — Bio::BaseSpace::BaseSpaceAPI
- #get_app_results — Bio::BaseSpace::Project
- #get_app_results_by_project — Bio::BaseSpace::BaseSpaceAPI
- #get_app_session — Bio::BaseSpace::BaseSpaceAPI
- #get_app_session_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_attr — Bio::BaseSpace::Model
- #get_available_genomes — Bio::BaseSpace::BaseSpaceAPI
- #get_coverage_meta — Bio::BaseSpace::File
- #get_coverage_meta_info — Bio::BaseSpace::BaseSpaceAPI
- #get_file_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_file_url — Bio::BaseSpace::File
- #get_files — Bio::BaseSpace::AppResult
- #get_files — Bio::BaseSpace::Sample
- #get_files_by_sample — Bio::BaseSpace::BaseSpaceAPI
- #get_genome_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_interval_coverage — Bio::BaseSpace::BaseSpaceAPI
- #get_interval_coverage — Bio::BaseSpace::File
- #get_parameter_dict — Bio::BaseSpace::QueryParameters
- #get_parameter_dict — Bio::BaseSpace::QueryParametersPurchasedProduct
- #get_project_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_project_by_user — Bio::BaseSpace::BaseSpaceAPI
- #get_projects — Bio::BaseSpace::User
- #get_purchase_by_id — Bio::BaseSpace::BillingAPI
- #get_referenced_app_results — Bio::BaseSpace::Sample
- #get_referenced_samples — Bio::BaseSpace::AppResult
- #get_referenced_samples_ids — Bio::BaseSpace::AppResult
- #get_runs — Bio::BaseSpace::User
- #get_sample_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_samples — Bio::BaseSpace::Project
- #get_samples_by_project — Bio::BaseSpace::BaseSpaceAPI
- #get_server_uri — Bio::BaseSpace::BaseAPI
- #get_trigger_object — Bio::BaseSpace::BaseSpaceAPI
- #get_user_by_id — Bio::BaseSpace::BaseSpaceAPI
- #get_user_products — Bio::BaseSpace::BillingAPI
- #get_variant_meta — Bio::BaseSpace::File
- #get_variant_metadata — Bio::BaseSpace::BaseSpaceAPI
- #get_verification_code — Bio::BaseSpace::BaseSpaceAPI
- #get_web_verification_code — Bio::BaseSpace::BaseSpaceAPI
- #haltUpload — Bio::BaseSpace::MultipartUpload
- #hasFinished — Bio::BaseSpace::MultipartUpload
- #hash2urlencode — Bio::BaseSpace::APIClient
- #hash2urlencode — Bio::BaseSpace::BaseAPI
- #id — Bio::BaseSpace::BaseSpaceModel
- #is_init — Bio::BaseSpace::AppResult
- #is_init — Bio::BaseSpace::BaseSpaceModel
- #is_init — Bio::BaseSpace::File
- #is_init — Bio::BaseSpace::Project
- #is_init — Bio::BaseSpace::Purchase
- #is_init — Bio::BaseSpace::Sample
- #is_init — Bio::BaseSpace::User
- #is_valid_file_option — Bio::BaseSpace::File
- #list_request — Bio::BaseSpace::BaseAPI
- #make_curl_request — Bio::BaseSpace::BaseAPI
- #method_missing — Bio::BaseSpace::Model
- #obtain_access_token — Bio::BaseSpace::BaseSpaceAPI
- #pauseUpload — Bio::BaseSpace::MultipartUpload
- #put_call — Bio::BaseSpace::APIClient
- #refund_purchase — Bio::BaseSpace::BillingAPI
- #run — Bio::BaseSpace::Consumer
- #run — Bio::BaseSpace::MultipartUpload
- #serialize_object — Bio::BaseSpace::BaseSpaceAPI
- #serialize_object — Bio::BaseSpace::AppSessionLaunchObject
- #serialize_references — Bio::BaseSpace::AppSession
- #set_access_token — Bio::BaseSpace::BaseAPI
- #set_api — Bio::BaseSpace::BaseSpaceModel
- #set_app_session_state — Bio::BaseSpace::BaseSpaceAPI
- #set_attr — Bio::BaseSpace::Model
- #set_status — Bio::BaseSpace::AppSession
- #set_timeout — Bio::BaseSpace::BaseAPI
- #setup — Bio::BaseSpace::MultipartUpload
- #single_request — Bio::BaseSpace::BaseAPI
- #startUpload — Bio::BaseSpace::MultipartUpload
- #to_path_value — Bio::BaseSpace::APIClient
- #to_s — Bio::BaseSpace::BaseAPI
- #to_s — Bio::BaseSpace::Model
- #to_s — Bio::BaseSpace::AppResult
- #to_s — Bio::BaseSpace::AppSession
- #to_s — Bio::BaseSpace::AppSessionCompact
- #to_s — Bio::BaseSpace::AppSessionLaunchObject
- #to_s — Bio::BaseSpace::ApplicationCompact
- #to_s — Bio::BaseSpace::BaseSpaceModel
- #to_s — Bio::BaseSpace::Coverage
- #to_s — Bio::BaseSpace::CoverageMetadata
- #to_s — Bio::BaseSpace::File
- #to_s — Bio::BaseSpace::GenomeV1
- #to_s — Bio::BaseSpace::UploadTask
- #to_s — Bio::BaseSpace::MultipartUpload
- #to_s — Bio::BaseSpace::Product
- #to_s — Bio::BaseSpace::Project
- #to_s — Bio::BaseSpace::Purchase
- #to_s — Bio::BaseSpace::PurchasedProduct
- #to_s — Bio::BaseSpace::QueryParameters
- #to_s — Bio::BaseSpace::QueryParametersPurchasedProduct
- #to_s — Bio::BaseSpace::RunCompact
- #to_s — Bio::BaseSpace::Sample
- #to_s — Bio::BaseSpace::User
- #to_s — Bio::BaseSpace::UserCompact
- #to_s — Bio::BaseSpace::Variant
- #to_s — Bio::BaseSpace::VariantHeader
- #to_str — Bio::BaseSpace::BaseAPI
- #to_str — Bio::BaseSpace::MultipartUpload
- #to_str — Bio::BaseSpace::QueryParameters
- #to_str — Bio::BaseSpace::QueryParametersPurchasedProduct
- #update_access_token — Bio::BaseSpace::BaseAPI
- #update_privileges — Bio::BaseSpace::BaseSpaceAPI
- #upload_file — Bio::BaseSpace::AppResult
- #upload_file_name — Bio::BaseSpace::UploadTask
- #upload_multipart_unit — Bio::BaseSpace::BaseSpaceAPI
- #validate — Bio::BaseSpace::QueryParameters
- #validate — Bio::BaseSpace::QueryParametersPurchasedProduct