CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List (Cloud Healthcare API v1beta1-rev20251016-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest<ListConsentsResponse>
        
        com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents

public class CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List
extends CloudHealthcareRequest<ListConsentsResponse>

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
Lists the Consent in the given consent store, returning each Consent's latest revision.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists the Consent in the given consent store, returning each Consent's latest revision.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getParent()` Required.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`set(String parameterName, Object value)`
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setAccessToken(String accessToken)` OAuth access token.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setAlt(String alt)` Data format for response.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setCallback(String callback)` JSONP
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setFilter(String filter)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setKey(String key)` API key.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setPageSize(Integer pageSize)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setPageToken(String pageToken)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setParent(String parent)` Required.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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
  - List
```
protected List(String parent)
```
    Lists the Consent in the given consent store, returning each Consent's latest revision. Create a request for the method "consents.list". This request holds the parameters needed by the the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudHealthcare.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - Required. Name of the consent store to retrieve Consents from.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListConsentsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListConsentsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudHealthcareRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudHealthcareRequest<ListConsentsResponse>
  - setAccessToken
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setAccessToken(String accessToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudHealthcareRequest<ListConsentsResponse>
  - setAlt
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setAlt(String alt)
```
    Description copied from class: CloudHealthcareRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudHealthcareRequest<ListConsentsResponse>
  - setCallback
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setCallback(String callback)
```
    Description copied from class: CloudHealthcareRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudHealthcareRequest<ListConsentsResponse>
  - setFields
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setFields(String fields)
```
    Description copied from class: CloudHealthcareRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudHealthcareRequest<ListConsentsResponse>
  - setKey
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setKey(String key)
```
    Description copied from class: CloudHealthcareRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class CloudHealthcareRequest<ListConsentsResponse>
  - setOauthToken
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setOauthToken(String oauthToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudHealthcareRequest<ListConsentsResponse>
  - setPrettyPrint
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudHealthcareRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudHealthcareRequest<ListConsentsResponse>
  - setQuotaUser
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setQuotaUser(String quotaUser)
```
    Description copied from class: CloudHealthcareRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class CloudHealthcareRequest<ListConsentsResponse>
  - setUploadType
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setUploadType(String uploadType)
```
    Description copied from class: CloudHealthcareRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudHealthcareRequest<ListConsentsResponse>
  - setUploadProtocol
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudHealthcareRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudHealthcareRequest<ListConsentsResponse>
  - getParent
```
public String getParent()
```
    Required. Name of the consent store to retrieve Consents from.
  - setParent
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setParent(String parent)
```
    Required. Name of the consent store to retrieve Consents from.
  - getFilter
```
public String getFilter()
```
    Optional. Restricts the consents returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
  - setFilter
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setFilter(String filter)
```
    Optional. Restricts the consents returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
  - getPageSize
```
public Integer getPageSize()
```
    Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000.
  - setPageSize
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setPageSize(Integer pageSize)
```
    Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000.
  - getPageToken
```
public String getPageToken()
```
    Optional. The next_page_token value returned from the previous List request, if any.
  - setPageToken
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List setPageToken(String pageToken)
```
    Optional. The next_page_token value returned from the previous List request, if any.
  - set
```
public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List set(String parameterName,
                                                                                   Object value)
```
    Overrides:
    
    set in class CloudHealthcareRequest<ListConsentsResponse>

Class CloudHealthcare.Projects.Locations.Datasets.ConsentStores.Consents.List

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

set