| <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="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.consentStores.html">consentStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.consentStores.consentArtifacts.html">consentArtifacts</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new Consent artifact in the parent Consent store.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified Consent artifact. Fails if it is referenced by the latest revision of any Consent.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the specified Consent artifact.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the Consent artifacts in the given Consent store.</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> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a new Consent artifact in the parent Consent store. |
| |
| Args: |
| parent: string, Required. The name of the Consent store this consent artifact belongs to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Proof of an end user's consent. |
| "consentContentVersion": "A String", # An string indicating the version of the consent content. |
| "metadata": { # Metadata associated with the consent artifact. For example, the consent locale or user agent version. |
| "a_key": "A String", |
| }, |
| "userSignature": { # User signature. # User's signature. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "witnessSignature": { # User signature. # A signature from a witness. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "guardianSignature": { # User signature. # A signature from guardian. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "consentContentScreenshots": [ # Screenshots of the consent content. |
| { # An image. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| ], |
| "userId": "A String", # Required. User's UUID provided by the client. |
| "name": "A String", # Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Proof of an end user's consent. |
| "consentContentVersion": "A String", # An string indicating the version of the consent content. |
| "metadata": { # Metadata associated with the consent artifact. For example, the consent locale or user agent version. |
| "a_key": "A String", |
| }, |
| "userSignature": { # User signature. # User's signature. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "witnessSignature": { # User signature. # A signature from a witness. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "guardianSignature": { # User signature. # A signature from guardian. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "consentContentScreenshots": [ # Screenshots of the consent content. |
| { # An image. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| ], |
| "userId": "A String", # Required. User's UUID provided by the client. |
| "name": "A String", # Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the specified Consent artifact. Fails if it is referenced by the latest revision of any Consent. |
| |
| Args: |
| name: string, Required. The resource name of the consent artifact to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 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(name, x__xgafv=None)</code> |
| <pre>Gets the specified Consent artifact. |
| |
| Args: |
| name: string, Required. The resource name of the consent artifact to retrieve. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Proof of an end user's consent. |
| "consentContentVersion": "A String", # An string indicating the version of the consent content. |
| "metadata": { # Metadata associated with the consent artifact. For example, the consent locale or user agent version. |
| "a_key": "A String", |
| }, |
| "userSignature": { # User signature. # User's signature. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "witnessSignature": { # User signature. # A signature from a witness. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "guardianSignature": { # User signature. # A signature from guardian. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "consentContentScreenshots": [ # Screenshots of the consent content. |
| { # An image. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| ], |
| "userId": "A String", # Required. User's UUID provided by the client. |
| "name": "A String", # Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the Consent artifacts in the given Consent store. |
| |
| Args: |
| parent: string, Required. Name of the Consent store to retrieve consent artifacts from. (required) |
| filter: string, Restricts the artifacts returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings The fields available for filtering are: - user_id - consent_content_version |
| pageSize: integer, Limit on the number of consent artifacts to return in a single response. If zero the default page size of 100 is used. |
| pageToken: string, The next_page_token value returned from the previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Lists the Consent artifacts in the given Consent store. |
| "consentArtifacts": [ # The returned consent artifacts. The maximum number of artifacts returned is determined by the value of page_size in the ListConsentArtifactsRequest. |
| { # Proof of an end user's consent. |
| "consentContentVersion": "A String", # An string indicating the version of the consent content. |
| "metadata": { # Metadata associated with the consent artifact. For example, the consent locale or user agent version. |
| "a_key": "A String", |
| }, |
| "userSignature": { # User signature. # User's signature. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "witnessSignature": { # User signature. # A signature from a witness. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "guardianSignature": { # User signature. # A signature from guardian. |
| "userId": "A String", # User's UUID provided by the client. |
| "image": { # An image. # An image of the user's signature. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| "metadata": { # Metadata associated with the user's signature. For example, the user's name or the user's title. |
| "a_key": "A String", |
| }, |
| "signatureTime": "A String", # Timestamp of the signature. |
| }, |
| "consentContentScreenshots": [ # Screenshots of the consent content. |
| { # An image. |
| "rawBytes": "A String", # Image content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response. |
| "gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the image. The URI must be in the following format: `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location. The image at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to image fetching requests return the image in raw_bytes. |
| }, |
| ], |
| "userId": "A String", # Required. User's UUID provided by the client. |
| "name": "A String", # Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. |
| }</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> |
| |
| </body></html> |
