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 more...

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.

[View source]

881
882
883
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 881

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) 

822
823
824
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 822

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) 

827
828
829
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 827

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>) 

839
840
841
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 839

def metadata
  @metadata
end

#name ⇒ String

Identifier. 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) 

846
847
848
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 846

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:


852
853
854
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 852

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) 

857
858
859
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 857

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) 

864
865
866
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 864

def revision_id
  @revision_id
end

#state ⇒ String

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

Returns:

  • (String) 

869
870
871
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 869

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) 

874
875
876
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 874

def ttl
  @ttl
end

#user_id ⇒ String

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

Returns:

  • (String) 

879
880
881
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 879

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 886

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