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

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
pulumi/pulumi-google-native

google-native.healthcare/v1.getConsent

Explore with Pulumi AI

google-native logo

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
pulumi/pulumi-google-native

    Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.

    Using getConsent

    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 getConsent(args: GetConsentArgs, opts?: InvokeOptions): Promise<GetConsentResult>
function getConsentOutput(args: GetConsentOutputArgs, opts?: InvokeOptions): Output<GetConsentResult>
    def get_consent(consent_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) -> GetConsentResult
def get_consent_output(consent_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[GetConsentResult]
    func LookupConsent(ctx *Context, args *LookupConsentArgs, opts ...InvokeOption) (*LookupConsentResult, error)
func LookupConsentOutput(ctx *Context, args *LookupConsentOutputArgs, opts ...InvokeOption) LookupConsentResultOutput

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

    public static class GetConsent 
{
    public static Task<GetConsentResult> InvokeAsync(GetConsentArgs args, InvokeOptions? opts = null)
    public static Output<GetConsentResult> Invoke(GetConsentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConsentResult> getConsent(GetConsentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:healthcare/v1:getConsent
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConsentId string
    ConsentStoreId string
    DatasetId string
    Location string
    Project string
    ConsentId string
    ConsentStoreId string
    DatasetId string
    Location string
    Project string
    consentId String
    consentStoreId String
    datasetId String
    location String
    project String
    consentId string
    consentStoreId string
    datasetId string
    location string
    project string
    consentId String
    consentStoreId String
    datasetId String
    location String
    project String

    getConsent Result

    The following output properties are available:

    ConsentArtifact string
    The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
    ExpireTime string
    Timestamp in UTC of when this Consent is considered expired.
    Metadata Dictionary<string, string>
    Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
    Name string
    Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
    Policies List<Pulumi.GoogleNative.Healthcare.V1.Outputs.GoogleCloudHealthcareV1ConsentPolicyResponse>
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    RevisionCreateTime string
    The timestamp that the revision was created.
    RevisionId string
    The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
    State string
    Indicates the current state of this Consent.
    Ttl string
    Input only. The time to live for this Consent from when it is created.
    UserId string
    User's UUID provided by the client.
    ConsentArtifact string
    The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
    ExpireTime string
    Timestamp in UTC of when this Consent is considered expired.
    Metadata map[string]string
    Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
    Name string
    Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
    Policies []GoogleCloudHealthcareV1ConsentPolicyResponse
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    RevisionCreateTime string
    The timestamp that the revision was created.
    RevisionId string
    The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
    State string
    Indicates the current state of this Consent.
    Ttl string
    Input only. The time to live for this Consent from when it is created.
    UserId string
    User's UUID provided by the client.
    consentArtifact String
    The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
    expireTime String
    Timestamp in UTC of when this Consent is considered expired.
    metadata Map<String,String>
    Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
    name String
    Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
    policies List<GoogleCloudHealthcareV1ConsentPolicyResponse>
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    revisionCreateTime String
    The timestamp that the revision was created.
    revisionId String
    The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
    state String
    Indicates the current state of this Consent.
    ttl String
    Input only. The time to live for this Consent from when it is created.
    userId String
    User's UUID provided by the client.
    consentArtifact string
    The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
    expireTime string
    Timestamp in UTC of when this Consent is considered expired.
    metadata {[key: string]: string}
    Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
    name string
    Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
    policies GoogleCloudHealthcareV1ConsentPolicyResponse[]
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    revisionCreateTime string
    The timestamp that the revision was created.
    revisionId string
    The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
    state string
    Indicates the current state of this Consent.
    ttl string
    Input only. The time to live for this Consent from when it is created.
    userId string
    User's UUID provided by the client.
    consent_artifact str
    The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
    expire_time str
    Timestamp in UTC of when this Consent is considered expired.
    metadata Mapping[str, str]
    Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
    name str
    Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
    policies Sequence[GoogleCloudHealthcareV1ConsentPolicyResponse]
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    revision_create_time str
    The timestamp that the revision was created.
    revision_id str
    The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
    state str
    Indicates the current state of this Consent.
    ttl str
    Input only. The time to live for this Consent from when it is created.
    user_id str
    User's UUID provided by the client.
    consentArtifact String
    The resource name of the Consent artifact that contains proof of the end user's consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}.
    expireTime String
    Timestamp in UTC of when this Consent is considered expired.
    metadata Map<String>
    Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent.
    name String
    Resource name of the Consent, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}. Cannot be changed after creation.
    policies List<Property Map>
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    revisionCreateTime String
    The timestamp that the revision was created.
    revisionId String
    The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending @{revision_id} to the Consent's resource name.
    state String
    Indicates the current state of this Consent.
    ttl String
    Input only. The time to live for this Consent from when it is created.
    userId String
    User's UUID provided by the client.

    Supporting Types

    AttributeResponse

    AttributeDefinitionId string
    Indicates the name of an attribute defined in the consent store.
    Values List<string>
    The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
    AttributeDefinitionId string
    Indicates the name of an attribute defined in the consent store.
    Values []string
    The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
    attributeDefinitionId String
    Indicates the name of an attribute defined in the consent store.
    values List<String>
    The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
    attributeDefinitionId string
    Indicates the name of an attribute defined in the consent store.
    values string[]
    The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
    attribute_definition_id str
    Indicates the name of an attribute defined in the consent store.
    values Sequence[str]
    The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
    attributeDefinitionId String
    Indicates the name of an attribute defined in the consent store.
    values List<String>
    The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.

    ExprResponse

    Description string
    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    Expression string
    Textual representation of an expression in Common Expression Language syntax.
    Location string
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    Title string
    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
    Description string
    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    Expression string
    Textual representation of an expression in Common Expression Language syntax.
    Location string
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    Title string
    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
    description String
    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    expression String
    Textual representation of an expression in Common Expression Language syntax.
    location String
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title String
    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
    description string
    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    expression string
    Textual representation of an expression in Common Expression Language syntax.
    location string
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title string
    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
    description str
    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    expression str
    Textual representation of an expression in Common Expression Language syntax.
    location str
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title str
    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
    description String
    Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    expression String
    Textual representation of an expression in Common Expression Language syntax.
    location String
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title String
    Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

    GoogleCloudHealthcareV1ConsentPolicyResponse

    AuthorizationRule Pulumi.GoogleNative.Healthcare.V1.Inputs.ExprResponse
    The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND (&&), OR (||).
    ResourceAttributes List<Pulumi.GoogleNative.Healthcare.V1.Inputs.AttributeResponse>
    The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
    AuthorizationRule ExprResponse
    The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND (&&), OR (||).
    ResourceAttributes []AttributeResponse
    The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
    authorizationRule ExprResponse
    The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND (&&), OR (||).
    resourceAttributes List<AttributeResponse>
    The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
    authorizationRule ExprResponse
    The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND (&&), OR (||).
    resourceAttributes AttributeResponse[]
    The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
    authorization_rule ExprResponse
    The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND (&&), OR (||).
    resource_attributes Sequence[AttributeResponse]
    The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.
    authorizationRule Property Map
    The request conditions to meet to grant access. In addition to any supported comparison operators, authorization rules may have IN operator as well as at most 10 logical operators that are limited to AND (&&), OR (||).
    resourceAttributes List<Property Map>
    The resources that this policy applies to. A resource is a match if it matches all the attributes listed here. If empty, this policy applies to all User data mappings for the given user.

    Package Details

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

    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
    pulumi/pulumi-google-native