google-api-python-client 2.143.0__py2.py3-none-any.whl → 2.145.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/healthcare.v1.json

@@ -2117,6 +2117,35 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"setBlobStorageSettings": {
+"description": "SetBlobStorageSettings sets the blob storage settings of the specified resources.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setBlobStorageSettings",
+"httpMethod": "POST",
+"id": "healthcare.projects.locations.datasets.dicomStores.setBlobStorageSettings",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setBlobStorageSettings",
+"request": {
+"$ref": "SetBlobStorageSettingsRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "setIamPolicy": {
 "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy",
@@ -2243,6 +2272,35 @@
 "https://www.googleapis.com/auth/cloud-healthcare",
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"setBlobStorageSettings": {
+"description": "SetBlobStorageSettings sets the blob storage settings of the specified resources.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:setBlobStorageSettings",
+"httpMethod": "POST",
+"id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/.*$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setBlobStorageSettings",
+"request": {
+"$ref": "SetBlobStorageSettingsRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -2274,6 +2332,38 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+},
+"resources": {
+"instances": {
+"methods": {
+"getStorageInfo": {
+"description": "GetStorageInfo returns the storage info of the specified resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}:getStorageInfo",
+"httpMethod": "GET",
+"id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "Required. The path of the instance to return storage info for, in the form: `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+/series/[^/]+/instances/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getStorageInfo",
+"response": {
+"$ref": "StorageInfo"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
 }
 }
 }
@@ -3251,6 +3341,116 @@
 "resources": {
 "fhir": {
 "methods": {
+"Binary-create": {
+"description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary",
+"httpMethod": "POST",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the FHIR store this resource belongs to.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/fhir/Binary",
+"request": {
+"$ref": "HttpBody"
+},
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"Binary-read": {
+"description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}",
+"httpMethod": "GET",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Binary resource to retrieve.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"Binary-update": {
+"description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}",
+"httpMethod": "PUT",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the resource to update.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "HttpBody"
+},
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"Binary-vread": {
+"description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}",
+"httpMethod": "GET",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Binary resource version to retrieve.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "Patient-everything": {
 "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. 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 resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything",
@@ -4110,7 +4310,7 @@
 ]
 },
 "rollback": {
-"description": "Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.",
+"description": "Rolls back messages from the HL7v2 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:rollback",
 "httpMethod": "POST",
 "id": "healthcare.projects.locations.datasets.hl7V2Stores.rollback",
@@ -4583,7 +4783,7 @@
 }
 }
 },
-"revision": "20240731",
+"revision": "20240822",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "ActivateConsentRequest": {
@@ -4826,6 +5026,66 @@
 },
 "type": "object"
 },
+"BlobStorageInfo": {
+"description": "BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will only be populated for DICOM resources.",
+"id": "BlobStorageInfo",
+"properties": {
+"sizeBytes": {
+"description": "Size in bytes of data stored in Blob Storage.",
+"format": "int64",
+"type": "string"
+},
+"storageClass": {
+"description": "The storage class in which the Blob data is stored.",
+"enum": [
+"BLOB_STORAGE_CLASS_UNSPECIFIED",
+"STANDARD",
+"NEARLINE",
+"COLDLINE",
+"ARCHIVE"
+],
+"enumDescriptions": [
+"If unspecified in CreateDataset, the StorageClass defaults to STANDARD. If unspecified in UpdateDataset and the StorageClass is set in the field mask, an InvalidRequest error is thrown.",
+"This stores the Object in Blob Standard Storage: https://cloud.google.com/storage/docs/storage-classes#standard",
+"This stores the Object in Blob Nearline Storage: https://cloud.google.com/storage/docs/storage-classes#nearline",
+"This stores the Object in Blob Coldline Storage: https://cloud.google.com/storage/docs/storage-classes#coldline",
+"This stores the Object in Blob Archive Storage: https://cloud.google.com/storage/docs/storage-classes#archive"
+],
+"type": "string"
+},
+"storageClassUpdateTime": {
+"description": "The time at which the storage class was updated. This is used to compute early deletion fees of the resource.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"BlobStorageSettings": {
+"description": "Settings for data stored in Blob storage.",
+"id": "BlobStorageSettings",
+"properties": {
+"blobStorageClass": {
+"description": "The Storage class in which the Blob data is stored.",
+"enum": [
+"BLOB_STORAGE_CLASS_UNSPECIFIED",
+"STANDARD",
+"NEARLINE",
+"COLDLINE",
+"ARCHIVE"
+],
+"enumDescriptions": [
+"If unspecified in CreateDataset, the StorageClass defaults to STANDARD. If unspecified in UpdateDataset and the StorageClass is set in the field mask, an InvalidRequest error is thrown.",
+"This stores the Object in Blob Standard Storage: https://cloud.google.com/storage/docs/storage-classes#standard",
+"This stores the Object in Blob Nearline Storage: https://cloud.google.com/storage/docs/storage-classes#nearline",
+"This stores the Object in Blob Coldline Storage: https://cloud.google.com/storage/docs/storage-classes#coldline",
+"This stores the Object in Blob Archive Storage: https://cloud.google.com/storage/docs/storage-classes#archive"
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "CancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "CancelOperationRequest",
@@ -6334,6 +6594,10 @@
 "description": "Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.",
 "id": "ImportDicomDataRequest",
 "properties": {
+"blobStorageSettings": {
+"$ref": "BlobStorageSettings",
+"description": "Optional. The blob storage settings for the data imported by this operation."
+},
 "gcsSource": {
 "$ref": "GoogleCloudHealthcareV1DicomGcsSource",
 "description": "Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage location."
@@ -7218,7 +7482,7 @@
 "type": "object"
 },
 "RollbackHL7MessagesFilteringFields": {
-"description": "Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back.",
+"description": "Filtering fields for an HL7v2 rollback. Currently only supports a list of operation ids to roll back.",
 "id": "RollbackHL7MessagesFilteringFields",
 "properties": {
 "operationIds": {
@@ -7287,7 +7551,7 @@
 "id": "RollbackHl7V2MessagesResponse",
 "properties": {
 "hl7v2Store": {
-"description": "The name of the HL7 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{hl7v2_store_id}\".",
+"description": "The name of the HL7v2 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{hl7v2_store_id}\".",
 "type": "string"
 }
 },
@@ -7505,6 +7769,27 @@
 },
 "type": "object"
 },
+"SetBlobStorageSettingsRequest": {
+"description": "Request message for `SetBlobStorageSettings` method.",
+"id": "SetBlobStorageSettingsRequest",
+"properties": {
+"blobStorageSettings": {
+"$ref": "BlobStorageSettings",
+"description": "The blob storage settings to update for the specified resources. Only fields listed in `update_mask` are applied."
+},
+"filterConfig": {
+"$ref": "DicomFilterConfig",
+"description": "Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`."
+}
+},
+"type": "object"
+},
+"SetBlobStorageSettingsResponse": {
+"description": "Returns additional info in regards to a completed set blob storage settings API.",
+"id": "SetBlobStorageSettingsResponse",
+"properties": {},
+"type": "object"
+},
 "SetIamPolicyRequest": {
 "description": "Request message for `SetIamPolicy` method.",
 "id": "SetIamPolicyRequest",
@@ -7575,6 +7860,25 @@
 },
 "type": "object"
 },
+"StorageInfo": {
+"description": "StorageInfo encapsulates all the storage info of a resource.",
+"id": "StorageInfo",
+"properties": {
+"blobStorageInfo": {
+"$ref": "BlobStorageInfo",
+"description": "Info about the data stored in blob storage for the resource."
+},
+"referencedResource": {
+"description": "The resource whose storage info is returned. For example: `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`",
+"type": "string"
+},
+"structuredStorageInfo": {
+"$ref": "StructuredStorageInfo",
+"description": "Info about the data stored in structured storage for the resource."
+}
+},
+"type": "object"
+},
 "StreamConfig": {
 "description": "Contains configuration for streaming FHIR export.",
 "id": "StreamConfig",
@@ -7597,6 +7901,18 @@
 },
 "type": "object"
 },
+"StructuredStorageInfo": {
+"description": "StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.",
+"id": "StructuredStorageInfo",
+"properties": {
+"sizeBytes": {
+"description": "Size in bytes of data stored in structured storage.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "StudyMetrics": {
 "description": "StudyMetrics contains metrics describing a DICOM study.",
 "id": "StudyMetrics",

googleapiclient/discovery_cache/documents/healthcare.v1beta1.json

@@ -4078,6 +4078,116 @@
 "resources": {
 "fhir": {
 "methods": {
+"Binary-create": {
+"description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary",
+"httpMethod": "POST",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the FHIR store this resource belongs to.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/fhir/Binary",
+"request": {
+"$ref": "HttpBody"
+},
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"Binary-read": {
+"description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}",
+"httpMethod": "GET",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Binary resource to retrieve.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"Binary-update": {
+"description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}",
+"httpMethod": "PUT",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the resource to update.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "HttpBody"
+},
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"Binary-vread": {
+"description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}",
+"httpMethod": "GET",
+"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Binary resource version to retrieve.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "HttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "ConceptMap-search-translate": {
 "description": "Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. 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.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/$translate",
@@ -5222,7 +5332,7 @@
 ]
 },
 "rollback": {
-"description": "Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.",
+"description": "Rolls back messages from the HL7v2 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:rollback",
 "httpMethod": "POST",
 "id": "healthcare.projects.locations.datasets.hl7V2Stores.rollback",
@@ -5748,7 +5858,7 @@
 }
 }
 },
-"revision": "20240808",
+"revision": "20240822",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "AccessDeterminationLogConfig": {
@@ -9684,7 +9794,7 @@
 "type": "object"
 },
 "RollbackHL7MessagesFilteringFields": {
-"description": "Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back.",
+"description": "Filtering fields for an HL7v2 rollback. Currently only supports a list of operation ids to roll back.",
 "id": "RollbackHL7MessagesFilteringFields",
 "properties": {
 "operationIds": {
@@ -9753,7 +9863,7 @@
 "id": "RollbackHl7V2MessagesResponse",
 "properties": {
 "hl7v2Store": {
-"description": "The name of the HL7 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{fhir_store_id}\".",
+"description": "The name of the HL7v2 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{fhir_store_id}\".",
 "type": "string"
 }
 },