1. Packages
  2. Google Cloud Native
  3. API Docs
  4. healthcare
  5. healthcare/v1
  6. getConsentArtifact

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.healthcare/v1.getConsentArtifact

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Gets the specified Consent artifact.

Using getConsentArtifact

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConsentArtifact(args: GetConsentArtifactArgs, opts?: InvokeOptions): Promise<GetConsentArtifactResult>
function getConsentArtifactOutput(args: GetConsentArtifactOutputArgs, opts?: InvokeOptions): Output<GetConsentArtifactResult>
Copy
def get_consent_artifact(consent_artifact_id: Optional[str] = None,
                         consent_store_id: Optional[str] = None,
                         dataset_id: Optional[str] = None,
                         location: Optional[str] = None,
                         project: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetConsentArtifactResult
def get_consent_artifact_output(consent_artifact_id: Optional[pulumi.Input[str]] = None,
                         consent_store_id: Optional[pulumi.Input[str]] = None,
                         dataset_id: Optional[pulumi.Input[str]] = None,
                         location: Optional[pulumi.Input[str]] = None,
                         project: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetConsentArtifactResult]
Copy
func LookupConsentArtifact(ctx *Context, args *LookupConsentArtifactArgs, opts ...InvokeOption) (*LookupConsentArtifactResult, error)
func LookupConsentArtifactOutput(ctx *Context, args *LookupConsentArtifactOutputArgs, opts ...InvokeOption) LookupConsentArtifactResultOutput
Copy

> Note: This function is named LookupConsentArtifact in the Go SDK.

public static class GetConsentArtifact 
{
    public static Task<GetConsentArtifactResult> InvokeAsync(GetConsentArtifactArgs args, InvokeOptions? opts = null)
    public static Output<GetConsentArtifactResult> Invoke(GetConsentArtifactInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConsentArtifactResult> getConsentArtifact(GetConsentArtifactArgs args, InvokeOptions options)
public static Output<GetConsentArtifactResult> getConsentArtifact(GetConsentArtifactArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:healthcare/v1:getConsentArtifact
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConsentArtifactId This property is required. string
ConsentStoreId This property is required. string
DatasetId This property is required. string
Location This property is required. string
Project string
ConsentArtifactId This property is required. string
ConsentStoreId This property is required. string
DatasetId This property is required. string
Location This property is required. string
Project string
consentArtifactId This property is required. String
consentStoreId This property is required. String
datasetId This property is required. String
location This property is required. String
project String
consentArtifactId This property is required. string
consentStoreId This property is required. string
datasetId This property is required. string
location This property is required. string
project string
consent_artifact_id This property is required. str
consent_store_id This property is required. str
dataset_id This property is required. str
location This property is required. str
project str
consentArtifactId This property is required. String
consentStoreId This property is required. String
datasetId This property is required. String
location This property is required. String
project String

getConsentArtifact Result

The following output properties are available:

ConsentContentScreenshots List<Pulumi.GoogleNative.Healthcare.V1.Outputs.ImageResponse>
Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
ConsentContentVersion string
Optional. An string indicating the version of the consent information shown to the user.
GuardianSignature Pulumi.GoogleNative.Healthcare.V1.Outputs.SignatureResponse
Optional. A signature from a guardian.
Metadata Dictionary<string, string>
Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
Name 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 string
User's UUID provided by the client.
UserSignature Pulumi.GoogleNative.Healthcare.V1.Outputs.SignatureResponse
Optional. User's signature.
WitnessSignature Pulumi.GoogleNative.Healthcare.V1.Outputs.SignatureResponse
Optional. A signature from a witness.
ConsentContentScreenshots []ImageResponse
Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
ConsentContentVersion string
Optional. An string indicating the version of the consent information shown to the user.
GuardianSignature SignatureResponse
Optional. A signature from a guardian.
Metadata map[string]string
Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
Name 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 string
User's UUID provided by the client.
UserSignature SignatureResponse
Optional. User's signature.
WitnessSignature SignatureResponse
Optional. A signature from a witness.
consentContentScreenshots List<ImageResponse>
Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion String
Optional. An string indicating the version of the consent information shown to the user.
guardianSignature SignatureResponse
Optional. A signature from a guardian.
metadata Map<String,String>
Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
name 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 String
User's UUID provided by the client.
userSignature SignatureResponse
Optional. User's signature.
witnessSignature SignatureResponse
Optional. A signature from a witness.
consentContentScreenshots ImageResponse[]
Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion string
Optional. An string indicating the version of the consent information shown to the user.
guardianSignature SignatureResponse
Optional. A signature from a guardian.
metadata {[key: string]: string}
Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
name 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 string
User's UUID provided by the client.
userSignature SignatureResponse
Optional. User's signature.
witnessSignature SignatureResponse
Optional. A signature from a witness.
consent_content_screenshots Sequence[ImageResponse]
Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consent_content_version str
Optional. An string indicating the version of the consent information shown to the user.
guardian_signature SignatureResponse
Optional. A signature from a guardian.
metadata Mapping[str, str]
Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
name str
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.
user_id str
User's UUID provided by the client.
user_signature SignatureResponse
Optional. User's signature.
witness_signature SignatureResponse
Optional. A signature from a witness.
consentContentScreenshots List<Property Map>
Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion String
Optional. An string indicating the version of the consent information shown to the user.
guardianSignature Property Map
Optional. A signature from a guardian.
metadata Map<String>
Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
name 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 String
User's UUID provided by the client.
userSignature Property Map
Optional. User's signature.
witnessSignature Property Map
Optional. A signature from a witness.

Supporting Types

ImageResponse

GcsUri This property is required. 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 This property is required. 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.
GcsUri This property is required. 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 This property is required. 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.
gcsUri This property is required. 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 This property is required. 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.
gcsUri This property is required. 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 This property is required. 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.
gcs_uri This property is required. str
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.
raw_bytes This property is required. str
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.
gcsUri This property is required. 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 This property is required. 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.

SignatureResponse

Image This property is required. Pulumi.GoogleNative.Healthcare.V1.Inputs.ImageResponse
Optional. An image of the user's signature.
Metadata This property is required. Dictionary<string, string>
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
SignatureTime This property is required. string
Optional. Timestamp of the signature.
UserId This property is required. string
User's UUID provided by the client.
Image This property is required. ImageResponse
Optional. An image of the user's signature.
Metadata This property is required. map[string]string
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
SignatureTime This property is required. string
Optional. Timestamp of the signature.
UserId This property is required. string
User's UUID provided by the client.
image This property is required. ImageResponse
Optional. An image of the user's signature.
metadata This property is required. Map<String,String>
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
signatureTime This property is required. String
Optional. Timestamp of the signature.
userId This property is required. String
User's UUID provided by the client.
image This property is required. ImageResponse
Optional. An image of the user's signature.
metadata This property is required. {[key: string]: string}
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
signatureTime This property is required. string
Optional. Timestamp of the signature.
userId This property is required. string
User's UUID provided by the client.
image This property is required. ImageResponse
Optional. An image of the user's signature.
metadata This property is required. Mapping[str, str]
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
signature_time This property is required. str
Optional. Timestamp of the signature.
user_id This property is required. str
User's UUID provided by the client.
image This property is required. Property Map
Optional. An image of the user's signature.
metadata This property is required. Map<String>
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
signatureTime This property is required. String
Optional. Timestamp of the signature.
userId This property is required. String
User's UUID provided by the client.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi