google-native.healthcare/v1.getConsentArtifact
Explore with Pulumi AI
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>
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]
func LookupConsentArtifact(ctx *Context, args *LookupConsentArtifactArgs, opts ...InvokeOption) (*LookupConsentArtifactResult, error)
func LookupConsentArtifactOutput(ctx *Context, args *LookupConsentArtifactOutputArgs, opts ...InvokeOption) LookupConsentArtifactResultOutput
> 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)
}
public static CompletableFuture<GetConsentArtifactResult> getConsentArtifact(GetConsentArtifactArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:healthcare/v1:getConsentArtifact
arguments:
# arguments dictionary
The following arguments are supported:
- Consent
Artifact stringId - Consent
Store stringId - Dataset
Id string - Location string
- Project string
- Consent
Artifact stringId - Consent
Store stringId - Dataset
Id string - Location string
- Project string
- consent
Artifact StringId - consent
Store StringId - dataset
Id String - location String
- project String
- consent
Artifact stringId - consent
Store stringId - dataset
Id string - location string
- project string
- consent_
artifact_ strid - consent_
store_ strid - dataset_
id str - location str
- project str
- consent
Artifact StringId - consent
Store StringId - dataset
Id String - location String
- project String
getConsentArtifact Result
The following output properties are available:
- Consent
Content List<Pulumi.Screenshots Google Native. Healthcare. V1. Outputs. Image Response> Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
- Consent
Content stringVersion Optional. An string indicating the version of the consent information shown to the user.
- Guardian
Signature Pulumi.Google Native. Healthcare. V1. Outputs. Signature Response 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.- User
Id string User's UUID provided by the client.
- User
Signature Pulumi.Google Native. Healthcare. V1. Outputs. Signature Response Optional. User's signature.
- Witness
Signature Pulumi.Google Native. Healthcare. V1. Outputs. Signature Response Optional. A signature from a witness.
- Consent
Content []ImageScreenshots Response Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
- Consent
Content stringVersion Optional. An string indicating the version of the consent information shown to the user.
- Guardian
Signature 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.- User
Id string User's UUID provided by the client.
- User
Signature SignatureResponse Optional. User's signature.
- Witness
Signature SignatureResponse Optional. A signature from a witness.
- consent
Content List<ImageScreenshots Response> Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
- consent
Content StringVersion Optional. An string indicating the version of the consent information shown to the user.
- guardian
Signature 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.- user
Id String User's UUID provided by the client.
- user
Signature SignatureResponse Optional. User's signature.
- witness
Signature SignatureResponse Optional. A signature from a witness.
- consent
Content ImageScreenshots Response[] Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
- consent
Content stringVersion Optional. An string indicating the version of the consent information shown to the user.
- guardian
Signature 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.- user
Id string User's UUID provided by the client.
- user
Signature SignatureResponse Optional. User's signature.
- witness
Signature SignatureResponse Optional. A signature from a witness.
- consent_
content_ Sequence[Imagescreenshots Response] Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
- consent_
content_ strversion 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.
- consent
Content List<Property Map>Screenshots Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
- consent
Content StringVersion Optional. An string indicating the version of the consent information shown to the user.
- guardian
Signature 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.- user
Id String User's UUID provided by the client.
- user
Signature Property Map Optional. User's signature.
- witness
Signature Property Map Optional. A signature from a witness.
Supporting Types
ImageResponse
- Gcs
Uri 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 theroles/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 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 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 theroles/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 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 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 theroles/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 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 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 theroles/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 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 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 theroles/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 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.
- gcs
Uri 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 theroles/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 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
Pulumi.
Google Native. Healthcare. V1. Inputs. Image Response Optional. An image of the user's signature.
- Metadata Dictionary<string, string>
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
- Signature
Time string Optional. Timestamp of the signature.
- User
Id string User's UUID provided by the client.
- Image
Image
Response Optional. An image of the user's signature.
- Metadata map[string]string
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
- Signature
Time string Optional. Timestamp of the signature.
- User
Id string User's UUID provided by the client.
- image
Image
Response Optional. An image of the user's signature.
- metadata Map<String,String>
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
- signature
Time String Optional. Timestamp of the signature.
- user
Id String User's UUID provided by the client.
- image
Image
Response Optional. An image of the user's signature.
- metadata {[key: string]: string}
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
- signature
Time string Optional. Timestamp of the signature.
- user
Id string User's UUID provided by the client.
- image
Image
Response Optional. An image of the user's signature.
- metadata Mapping[str, str]
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
- signature_
time str Optional. Timestamp of the signature.
- user_
id str User's UUID provided by the client.
- image Property Map
Optional. An image of the user's signature.
- metadata Map<String>
Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
- signature
Time String Optional. Timestamp of the signature.
- user
Id String User's UUID provided by the client.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0