Class: Google::Apis::HealthcareV1::Consent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/healthcare_v1/classes.rb,
lib/google/apis/healthcare_v1/representations.rb,
lib/google/apis/healthcare_v1/representations.rb

Overview

Represents a user's consent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Consent

Returns a new instance of Consent.



567
568
569
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 567

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

Required. 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`. Corresponds to the JSON propertyconsentArtifact`

Returns:

  • (String) 


508
509
510
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 508

def consent_artifact
  @consent_artifact
end

#expire_time ⇒ String

Timestamp in UTC of when this Consent is considered expired. Corresponds to the JSON property expireTime

Returns:

  • (String) 


513
514
515
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 513

def expire_time
  @expire_time
end

#metadata ⇒ Hash<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. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


525
526
527
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 525

def metadata
  @metadata
end

#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. Corresponds to the JSON propertyname`

Returns:

  • (String) 


532
533
534
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 532

def name
  @name
end

#policies ⇒ Array<Google::Apis::HealthcareV1::GoogleCloudHealthcareV1ConsentPolicy>

Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. Corresponds to the JSON property policies

Returns:



538
539
540
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 538

def policies
  @policies
end

#revision_create_time ⇒ String

Output only. The timestamp that the revision was created. Corresponds to the JSON property revisionCreateTime

Returns:

  • (String) 


543
544
545
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 543

def revision_create_time
  @revision_create_time
end

#revision_id ⇒ String

Output only. 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. Corresponds to the JSON propertyrevisionId`

Returns:

  • (String) 


550
551
552
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 550

def revision_id
  @revision_id
end

#state ⇒ String

Required. Indicates the current state of this Consent. Corresponds to the JSON property state

Returns:

  • (String) 


555
556
557
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 555

def state
  @state
end

#ttl ⇒ String

Input only. The time to live for this Consent from when it is created. Corresponds to the JSON property ttl

Returns:

  • (String) 


560
561
562
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 560

def ttl
  @ttl
end

#user_id ⇒ String

Required. User's UUID provided by the client. Corresponds to the JSON property userId

Returns:

  • (String) 


565
566
567
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 565

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 572

def update!(**args)
  @consent_artifact = args[:consent_artifact] if args.key?(:consent_artifact)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @policies = args[:policies] if args.key?(:policies)
  @revision_create_time = args[:revision_create_time] if args.key?(:revision_create_time)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @state = args[:state] if args.key?(:state)
  @ttl = args[:ttl] if args.key?(:ttl)
  @user_id = args[:user_id] if args.key?(:user_id)
end