com.google.api.services.healthcare.v1beta1

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

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

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir

public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete
extends CloudHealthcareRequest<Empty>

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	ConditionalDelete(String parent, String type) Deletes FHIR resources that match a search query.

Method Summary

Modifier and Type	Method and Description
String	getParent() Required.
String	getType() Required.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	set(String parameterName, Object value)
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	set$Xgafv(String $Xgafv) V1 error format.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setAccessToken(String accessToken) OAuth access token.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setAlt(String alt) Data format for response.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setCallback(String callback) JSONP
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setKey(String key) API key.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setParent(String parent) Required.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setType(String type) Required.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	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

ConditionalDelete

protected ConditionalDelete(String parent,
                            String type)

Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/fhir/R4/http.html#3.1.0.7.1), [R5](https://hl7.org/fhir/R5/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#conditionally_deleting_a_fhir_resource). Create a request for the method "fhir.conditionalDelete". 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.

ConditionalDelete#initialize(com.google.api.client.googleapis.services.Ab stractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

parent - Required. The name of the FHIR store this resource belongs to.

type - Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).

Since:

1.13

Method Detail

set$Xgafv

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete set$Xgafv(String $Xgafv)

Description copied from class: CloudHealthcareRequest

V1 error format.

Overrides:

set$Xgafv in class CloudHealthcareRequest<Empty>

setAccessToken

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setAccessToken(String accessToken)

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<Empty>

setAlt

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setAlt(String alt)

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<Empty>

setCallback

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setCallback(String callback)

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<Empty>

setFields

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setFields(String fields)

Description copied from class: CloudHealthcareRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudHealthcareRequest<Empty>

setKey

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete 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<Empty>

setOauthToken

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setOauthToken(String oauthToken)

Description copied from class: CloudHealthcareRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudHealthcareRequest<Empty>

setPrettyPrint

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudHealthcareRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudHealthcareRequest<Empty>

setQuotaUser

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete 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<Empty>

setUploadType

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setUploadType(String uploadType)

Description copied from class: CloudHealthcareRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudHealthcareRequest<Empty>

setUploadProtocol

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setUploadProtocol(String uploadProtocol)

Description copied from class: CloudHealthcareRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudHealthcareRequest<Empty>

getParent

public String getParent()

Required. The name of the FHIR store this resource belongs to.

setParent

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setParent(String parent)

Required. The name of the FHIR store this resource belongs to.

getType

public String getType()

Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).

setType

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete setType(String type)

Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).

set

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete set(String parameterName,
                                                                                         Object value)

Overrides:

set in class CloudHealthcareRequest<Empty>