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 the artifact 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 specified 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:
{ # Documentation of a user's consent.
"consentContentScreenshots": [ # Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
{ # Raw bytes representing consent artifact content.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
],
"consentContentVersion": "A String", # Optional. An string indicating the version of the consent information shown to the user.
"guardianSignature": { # User signature. # Optional. A signature from a guardian.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"metadata": { # Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
"a_key": "A String",
},
"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}`. Cannot be changed after creation.
"userId": "A String", # Required. User's UUID provided by the client.
"userSignature": { # User signature. # Optional. User's signature.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"witnessSignature": { # User signature. # Optional. A signature from a witness.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Documentation of a user's consent.
"consentContentScreenshots": [ # Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
{ # Raw bytes representing consent artifact content.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
],
"consentContentVersion": "A String", # Optional. An string indicating the version of the consent information shown to the user.
"guardianSignature": { # User signature. # Optional. A signature from a guardian.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"metadata": { # Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
"a_key": "A String",
},
"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}`. Cannot be changed after creation.
"userId": "A String", # Required. User's UUID provided by the client.
"userSignature": { # User signature. # Optional. User's signature.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"witnessSignature": { # User signature. # Optional. A signature from a witness.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
}
delete(name, x__xgafv=None)
Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.
Args:
name: string, Required. The resource name of the Consent artifact to delete. To preserve referential integrity, Consent artifacts referenced by the latest revision of a Consent cannot be deleted. (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:
{ # Documentation of a user's consent.
"consentContentScreenshots": [ # Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
{ # Raw bytes representing consent artifact content.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
],
"consentContentVersion": "A String", # Optional. An string indicating the version of the consent information shown to the user.
"guardianSignature": { # User signature. # Optional. A signature from a guardian.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"metadata": { # Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
"a_key": "A String",
},
"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}`. Cannot be changed after creation.
"userId": "A String", # Required. User's UUID provided by the client.
"userSignature": { # User signature. # Optional. User's signature.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"witnessSignature": { # User signature. # Optional. A signature from a witness.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the Consent artifacts in the specified consent store.
Args:
parent: string, Required. Name of the consent store to retrieve consent artifacts from. (required)
filter: string, Optional. Restricts the artifacts returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter=user_id=\"user123\"`. - consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
pageSize: integer, Optional. Limit on the number of consent artifacts to return in a single response. If not specified, 100 is used. May not be larger than 1000.
pageToken: string, Optional. 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:
{
"consentArtifacts": [ # The returned Consent artifacts. The maximum number of artifacts returned is determined by the value of page_size in the ListConsentArtifactsRequest.
{ # Documentation of a user's consent.
"consentContentScreenshots": [ # Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
{ # Raw bytes representing consent artifact content.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
],
"consentContentVersion": "A String", # Optional. An string indicating the version of the consent information shown to the user.
"guardianSignature": { # User signature. # Optional. A signature from a guardian.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"metadata": { # Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
"a_key": "A String",
},
"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}`. Cannot be changed after creation.
"userId": "A String", # Required. User's UUID provided by the client.
"userSignature": { # User signature. # Optional. User's signature.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
"witnessSignature": { # User signature. # Optional. A signature from a witness.
"image": { # Raw bytes representing consent artifact content. # Optional. An image of the user's signature.
"gcsUri": "A String", # Input only. Points to a Cloud Storage URI containing the consent artifact content. 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 consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
"rawBytes": "A String", # Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
},
"metadata": { # Optional. 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", # Optional. Timestamp of the signature.
"userId": "A String", # Required. User's UUID provided by the client.
},
},
],
"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.