google_api_genomics v0.0.1 GoogleApi.Genomics.V1.Api.Datasets View Source
API calls for all endpoints tagged Datasets
.
Link to this section Summary
Functions
Creates a new dataset. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the datasets.undelete operation. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Gets a dataset by ID. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See <a href="/iam/docs/managing-policies#getting_a_policy">Getting a Policy</a> for more information. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Lists datasets within a project. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Updates a dataset. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics This method supports patch semantics
Sets the access control policy on the specified dataset. Replaces any existing policy. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics See <a href="/iam/docs/managing-policies#setting_a_policy">Setting a Policy</a> for more information
Returns permissions that a caller has on the specified resource. See <a href="/iam/docs/managing-policies#testing_permissions">Testing Permissions</a> for more information. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Undeletes a dataset by restoring a dataset which was deleted via this API. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics This operation is only possible for a week after the deletion occurred
Link to this section Functions
genomics_datasets_create(Tesla.Env.client, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Dataset.t} | {:error, Tesla.Env.t}
Creates a new dataset. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :body (Dataset):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Dataset{}} on success {:error, info} on failure
genomics_datasets_delete(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Deletes a dataset and all of its contents (all read group sets, reference sets, variant sets, call sets, annotation sets, etc.) This is reversible (up to one week after the deletion) via the datasets.undelete operation. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- dataset_id (String): The ID of the dataset to be deleted.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Empty{}} on success {:error, info} on failure
genomics_datasets_get(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Dataset.t} | {:error, Tesla.Env.t}
Gets a dataset by ID. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- dataset_id (String): The ID of the dataset.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Dataset{}} on success {:error, info} on failure
genomics_datasets_get_iam_policy(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See <a href="/iam/docs/managing-policies#getting_a_policy">Getting a Policy</a> for more information. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- resource (String): REQUIRED: The resource for which policy is being specified. Format is `datasets/<dataset ID>`.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :body (GetIamPolicyRequest):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Policy{}} on success {:error, info} on failure
genomics_datasets_list(Tesla.Env.client, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.ListDatasetsResponse.t} | {:error, Tesla.Env.t}
Lists datasets within a project. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :page_size (Integer): The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.
- :project_id (String): Required. The Google Cloud project ID to list datasets for.
- :page_token (String): The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
Returns
{:ok, %GoogleApi.Genomics.V1.Model.ListDatasetsResponse{}} on success {:error, info} on failure
genomics_datasets_patch(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Dataset.t} | {:error, Tesla.Env.t}
Updates a dataset. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics This method supports patch semantics.
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- dataset_id (String): The ID of the dataset to be updated.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :update_mask (String): An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
- :body (Dataset):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Dataset{}} on success {:error, info} on failure
genomics_datasets_set_iam_policy(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Sets the access control policy on the specified dataset. Replaces any existing policy. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics See <a href="/iam/docs/managing-policies#setting_a_policy">Setting a Policy</a> for more information.
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- resource (String): REQUIRED: The resource for which policy is being specified. Format is `datasets/<dataset ID>`.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Policy{}} on success {:error, info} on failure
genomics_datasets_test_iam_permissions(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.TestIamPermissionsResponse.t} | {:error, Tesla.Env.t}
Returns permissions that a caller has on the specified resource. See <a href="/iam/docs/managing-policies#testing_permissions">Testing Permissions</a> for more information. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- resource (String): REQUIRED: The resource for which policy is being specified. Format is `datasets/<dataset ID>`.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
genomics_datasets_undelete(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Genomics.V1.Model.Dataset.t} | {:error, Tesla.Env.t}
Undeletes a dataset by restoring a dataset which was deleted via this API. For the definitions of datasets and other genomics resources, see Fundamentals of Google Genomics This operation is only possible for a week after the deletion occurred.
Parameters
- connection (GoogleApi.Genomics.V1.Connection): Connection to server
- dataset_id (String): The ID of the dataset to be undeleted.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :body (UndeleteDatasetRequest):
Returns
{:ok, %GoogleApi.Genomics.V1.Model.Dataset{}} on success {:error, info} on failure