CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup (Cloud Healthcare API v1beta1-rev20250409-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.BulkExportGroup

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

Enclosing class:: CloudHealthcare.Projects.Locations.Datasets.FhirStores

public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup
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`	`BulkExportGroup(String name)` Bulk exports a Group resource and resources in the member field, including related resources for each Patient member.

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`	`getName()` Required.
`String`	`getOrganizeOutputBy()` Optional.
`String`	`getOutputFormat()` Optional.
`String`	`getSince()` Optional.
`String`	`getType()` Optional.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`set(String parameterName, Object value)`
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setAccessToken(String accessToken)` OAuth access token.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setAlt(String alt)` Data format for response.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setCallback(String callback)` JSONP
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setKey(String key)` API key.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setName(String name)` Required.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setOrganizeOutputBy(String organizeOutputBy)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setOutputFormat(String outputFormat)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setSince(String since)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setType(String type)` Optional.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup`	`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
  - BulkExportGroup
```
protected BulkExportGroup(String name)
```
    Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide [$export group of patients](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---group-of-patients). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma- delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * `_since`: if provided, only resources updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * `organizeOutputBy`: resource type to organize the output by. Required and must be set to `Patient`. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the `Content-Location` header of response is set to a URL that you can use to query the status of the export. The URL is in the format `projects/{project_id}/locations/{location_id}/datasets/{d ataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. Create a request for the method "fhirStores.bulk-export-group". 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.
    BulkExportGroup#initialize(com.google.api.client.googleapis.services.Abst ractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations/ {location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.
    
    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<HttpBody>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<HttpBody>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup 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.BulkExportGroup setAccessToken(String accessToken)
```
    Description copied from class: CloudHealthcareRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudHealthcareRequest<HttpBody>
  - setAlt
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup 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.BulkExportGroup setCallback(String callback)
```
    Description copied from class: CloudHealthcareRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudHealthcareRequest<HttpBody>
  - setFields
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup 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.BulkExportGroup 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.BulkExportGroup 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.BulkExportGroup 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.BulkExportGroup 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.BulkExportGroup 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.BulkExportGroup setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudHealthcareRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudHealthcareRequest<HttpBody>
  - getName
```
public String getName()
```
    Required. Name of the `Group` resource that is exported, in format `projects/{project_id}/locations /{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`.
  - setName
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup setName(String name)
```
    Required. Name of the `Group` resource that is exported, in format `projects/{project _id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Gr oup/{group_id}`.
  - getSince
```
public String getSince()
```
    Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
  - setSince
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup setSince(String since)
```
    Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
  - getType
```
public String getType()
```
    Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
  - setType
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup setType(String type)
```
    Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported.
  - getOrganizeOutputBy
```
public String getOrganizeOutputBy()
```
    Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.
  - setOrganizeOutputBy
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup setOrganizeOutputBy(String organizeOutputBy)
```
    Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows: * Patient file(s) containing the Patient resources. Each Patient is sequentially followed by all resources the Patient references, and all resources that reference the Patient (equivalent to a GetPatientEverything request). * Individual files grouped by resource type for resources in the Group's member field and the Group resource itself. Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files.
  - getOutputFormat
```
public String getOutputFormat()
```
    Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
  - setOutputFormat
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup setOutputFormat(String outputFormat)
```
    Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported.
  - set
```
public CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup set(String parameterName,
                                                                                  Object value)
```
    Overrides:
    
    set in class CloudHealthcareRequest<HttpBody>

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores.BulkExportGroup

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

BulkExportGroup

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

getSince

setSince

getType

setType

getOrganizeOutputBy

setOrganizeOutputBy

getOutputFormat

setOutputFormat

set