Consent (Cloud Healthcare API v1beta1-rev20241009-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.healthcare.v1beta1.model.Consent

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Consent
extends com.google.api.client.json.GenericJson
```
Represents a user's consent.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Consent()

Constructors
Constructor and Description
`Consent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Consent`	`clone()`
`String`	`getConsentArtifact()` Required.
`String`	`getExpireTime()` Timestamp in UTC of when this Consent is considered expired.
`Map<String,String>`	`getMetadata()` Optional.
`String`	`getName()` Identifier.
`List<GoogleCloudHealthcareV1beta1ConsentPolicy>`	`getPolicies()` Optional.
`String`	`getRevisionCreateTime()` Output only.
`String`	`getRevisionId()` Output only.
`String`	`getState()` Required.
`String`	`getTtl()` Input only.
`String`	`getUserId()` Required.
`Consent`	`set(String fieldName, Object value)`
`Consent`	`setConsentArtifact(String consentArtifact)` Required.
`Consent`	`setExpireTime(String expireTime)` Timestamp in UTC of when this Consent is considered expired.
`Consent`	`setMetadata(Map<String,String> metadata)` Optional.
`Consent`	`setName(String name)` Identifier.
`Consent`	`setPolicies(List<GoogleCloudHealthcareV1beta1ConsentPolicy> policies)` Optional.
`Consent`	`setRevisionCreateTime(String revisionCreateTime)` Output only.
`Consent`	`setRevisionId(String revisionId)` Output only.
`Consent`	`setState(String state)` Required.
`Consent`	`setTtl(String ttl)` Input only.
`Consent`	`setUserId(String userId)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Consent
```
public Consent()
```
- Method Detail
  - getConsentArtifact
```
public String getConsentArtifact()
```
    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}/conse ntStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`.
    
    Returns:
    
    value or null for none
  - setConsentArtifact
```
public Consent setConsentArtifact(String consentArtifact)
```
    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}/conse ntStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`.
    
    Parameters:
    
    consentArtifact - consentArtifact or null for none
  - getExpireTime
```
public String getExpireTime()
```
    Timestamp in UTC of when this Consent is considered expired.
    
    Returns:
    
    value or null for none
  - setExpireTime
```
public Consent setExpireTime(String expireTime)
```
    Timestamp in UTC of when this Consent is considered expired.
    
    Parameters:
    
    expireTime - expireTime or null for none
  - getMetadata
```
public Map<String,String> getMetadata()
```
    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.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Consent setMetadata(Map<String,String> metadata)
```
    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.
    
    Parameters:
    
    metadata - metadata or null for none
  - getName
```
public String getName()
```
    Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{locatio n_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.
    
    Returns:
    
    value or null for none
  - setName
```
public Consent setName(String name)
```
    Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{locatio n_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.
    
    Parameters:
    
    name - name or null for none
  - getPolicies
```
public List<GoogleCloudHealthcareV1beta1ConsentPolicy> getPolicies()
```
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    
    Returns:
    
    value or null for none
  - setPolicies
```
public Consent setPolicies(List<GoogleCloudHealthcareV1beta1ConsentPolicy> policies)
```
    Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions.
    
    Parameters:
    
    policies - policies or null for none
  - getRevisionCreateTime
```
public String getRevisionCreateTime()
```
    Output only. The timestamp that the revision was created.
    
    Returns:
    
    value or null for none
  - setRevisionCreateTime
```
public Consent setRevisionCreateTime(String revisionCreateTime)
```
    Output only. The timestamp that the revision was created.
    
    Parameters:
    
    revisionCreateTime - revisionCreateTime or null for none
  - getRevisionId
```
public String getRevisionId()
```
    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.
    
    Returns:
    
    value or null for none
  - setRevisionId
```
public Consent setRevisionId(String revisionId)
```
    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.
    
    Parameters:
    
    revisionId - revisionId or null for none
  - getState
```
public String getState()
```
    Required. Indicates the current state of this Consent.
    
    Returns:
    
    value or null for none
  - setState
```
public Consent setState(String state)
```
    Required. Indicates the current state of this Consent.
    
    Parameters:
    
    state - state or null for none
  - getTtl
```
public String getTtl()
```
    Input only. The time to live for this Consent from when it is created.
    
    Returns:
    
    value or null for none
  - setTtl
```
public Consent setTtl(String ttl)
```
    Input only. The time to live for this Consent from when it is created.
    
    Parameters:
    
    ttl - ttl or null for none
  - getUserId
```
public String getUserId()
```
    Required. User's UUID provided by the client.
    
    Returns:
    
    value or null for none
  - setUserId
```
public Consent setUserId(String userId)
```
    Required. User's UUID provided by the client.
    
    Parameters:
    
    userId - userId or null for none
  - set
```
public Consent set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Consent clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Consent

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Consent

Method Detail

getConsentArtifact

setConsentArtifact

getExpireTime

setExpireTime

getMetadata

setMetadata

getName

setName

getPolicies

setPolicies

getRevisionCreateTime

setRevisionCreateTime

getRevisionId

setRevisionId

getState

setState

getTtl

setTtl

getUserId

setUserId

set

clone