CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search (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.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest<HttpBody>
        
        com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir
```
public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search
extends CloudHealthcareRequest<HttpBody>
```

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`	`Search(String parent, SearchResourcesRequest content)` Searches for resources in the given FHIR store according to criteria specified as query parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getParent()` Required.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`set(String parameterName, Object value)`
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setAccessToken(String accessToken)` OAuth access token.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setAlt(String alt)` Data format for response.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setCallback(String callback)` JSONP
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setKey(String key)` API key.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setParent(String parent)` Required.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search`	`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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
  - Search
```
protected Search(String parent,
                 SearchResourcesRequest content)
```
    Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form- urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir- advanced-search). Create a request for the method "fhir.search". 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 FHIR store to retrieve resources from.
    
    content - the SearchResourcesRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudHealthcareRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudHealthcareRequest<HttpBody>
  - setAccessToken
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setAccessToken(String accessToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudHealthcareRequest<HttpBody>
  - setAlt
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setAlt(String alt)
```
    Description copied from class: CloudHealthcareRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudHealthcareRequest<HttpBody>
  - setCallback
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setCallback(String callback)
```
    Description copied from class: CloudHealthcareRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudHealthcareRequest<HttpBody>
  - setFields
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setFields(String fields)
```
    Description copied from class: CloudHealthcareRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudHealthcareRequest<HttpBody>
  - setKey
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search 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<HttpBody>
  - setOauthToken
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setOauthToken(String oauthToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudHealthcareRequest<HttpBody>
  - setPrettyPrint
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudHealthcareRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudHealthcareRequest<HttpBody>
  - setQuotaUser
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search 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<HttpBody>
  - setUploadType
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setUploadType(String uploadType)
```
    Description copied from class: CloudHealthcareRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudHealthcareRequest<HttpBody>
  - setUploadProtocol
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudHealthcareRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudHealthcareRequest<HttpBody>
  - getParent
```
public String getParent()
```
    Required. Name of the FHIR store to retrieve resources from.
  - setParent
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search setParent(String parent)
```
    Required. Name of the FHIR store to retrieve resources from.
  - set
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search set(String parameterName,
                                                                              Object value)
```
    Overrides:
    
    set in class CloudHealthcareRequest<HttpBody>

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search

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

Search

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

set