| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="genomics_v1.html">Genomics API</a> . <a href="genomics_v1.datasets.html">datasets</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new dataset.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(datasetId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a dataset.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(datasetId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a dataset by ID.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#list">list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists datasets within a project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(datasetId, body, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a dataset. This method supports patch semantics.</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p> |
| <p class="firstline"></p> |
| <p class="toc_element"> |
| <code><a href="#undelete">undelete(datasetId, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(body, x__xgafv=None)</code> |
| <pre>Creates a new dataset. |
| |
| Args: |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(datasetId, x__xgafv=None)</code> |
| <pre>Deletes a dataset. |
| |
| Args: |
| datasetId: string, The ID of the dataset to be deleted. (required) |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(datasetId, x__xgafv=None)</code> |
| <pre>Gets a dataset by ID. |
| |
| Args: |
| datasetId: string, The ID of the dataset. (required) |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for `GetIamPolicy` method. |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). |
| "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| "A String", |
| ], |
| }, |
| ], |
| "version": 42, # Version of the `Policy`. The default version is 0. |
| "etag": "A String", # Can be used to perform a read-modify-write. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists datasets within a project. |
| |
| Args: |
| pageSize: integer, The maximum number of results returned by this request. If unspecified, defaults to 50. The maximum value is 1024. |
| projectId: string, Required. The project to list datasets for. |
| pageToken: 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. |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # The dataset list response. |
| "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results. |
| "datasets": [ # The list of matching Datasets. |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(datasetId, body, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a dataset. This method supports patch semantics. |
| |
| Args: |
| datasetId: string, The ID of the dataset to be updated. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| } |
| |
| updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is [name][google.genomics.v1.Dataset.name]. The only acceptable value is "name". If unspecified, all mutable fields will be updated. |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. |
| "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| "A String", |
| ], |
| }, |
| ], |
| "version": 42, # Version of the `Policy`. The default version is 0. |
| "etag": "A String", # Can be used to perform a read-modify-write. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). |
| "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. |
| "A String", |
| ], |
| }, |
| ], |
| "version": 42, # Version of the `Policy`. The default version is 0. |
| "etag": "A String", # Can be used to perform a read-modify-write. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code> |
| <pre> |
| |
| Args: |
| resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for `TestIamPermissions` method. |
| "permissions": [ # REQUIRED: The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. Allowed permissions are: * `genomics.datasets.create` * `genomics.datasets.delete` * `genomics.datasets.get` * `genomics.datasets.list` * `genomics.datasets.update` * `genomics.datasets.getIamPolicy` * `genomics.datasets.setIamPolicy` |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="undelete">undelete(datasetId, body, x__xgafv=None)</code> |
| <pre>Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred. |
| |
| Args: |
| datasetId: string, The ID of the dataset to be undeleted. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { |
| } |
| |
| x__xgafv: string, V1 error format. |
| |
| Returns: |
| An object of the form: |
| |
| { # A Dataset is a collection of genomic data. |
| "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. |
| "id": "A String", # The server-generated dataset ID, unique across all datasets. |
| "createTime": "A String", # The time this dataset was created, in seconds from the epoch. |
| "name": "A String", # The dataset name. |
| }</pre> |
| </div> |
| |
| </body></html> |