Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a new Consent artifact in the parent Consent store.
Deletes the specified Consent artifact. Fails if it is referenced by the latest revision of any Consent.
Gets the specified Consent artifact.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the Consent artifacts in the given Consent store.
list_next(previous_request, previous_response)
Retrieves the next page of results.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
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}`. }
delete(name, x__xgafv=None)
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 `{}`. }
get(name, x__xgafv=None)
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}`. }
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
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. }
list_next(previous_request, previous_response)
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.