# Package google.cloud.healthcare.v1beta1.storageinfo

## Index

- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.StorageInfoService` (interface)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.BlobStorageInfo` (message)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.BlobStorageSettings` (message)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.GetStorageInfoRequest` (message)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.SetBlobStorageSettingsRequest` (message)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.SetBlobStorageSettingsResponse` (message)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.StorageInfo` (message)
- `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.StructuredStorageInfo` (message)

## StorageInfoService

A service for handling the storage info for data stored in the Cloud Healthcare API. Storage info contains information about the data that is stored in the Cloud Healthcare API, like the size of the data stored in Structured Storage, Blob Storage and other storage information.

| GetStorageInfo |
|---|
| `` rpc GetStorageInfo(`https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.GetStorageInfoRequest`) returns (`https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.StorageInfo`) `` GetStorageInfo returns the storage info of the specified resource. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-healthcare` - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/). |

| SetBlobStorageSettings |
|---|
| `` rpc SetBlobStorageSettings(`https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.SetBlobStorageSettingsRequest`) returns (`https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` SetBlobStorageSettings sets the blob storage settings of the specified resources. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-healthcare` - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/). |

## BlobStorageInfo

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.

| Fields ||
|---|---|
| `size_bytes` | `int64` Size in bytes of data stored in Blob Storage. |
| `storage_class` | `` `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1#google.cloud.healthcare.v1beta1.BlobStorageClass` `` The storage class in which the Blob data is stored. |
| `storage_class_update_time` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` `` The time at which the storage class was updated. This is used to compute early deletion fees of the resource. |

## BlobStorageSettings

Settings for data stored in Blob storage.

| Fields ||
|---|---|
| `blob_storage_class` | `` `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1#google.cloud.healthcare.v1beta1.BlobStorageClass` `` The Storage class in which the Blob data is stored. |

## GetStorageInfoRequest

Request message for `GetStorageInfo` method.

| Fields ||
|---|---|
| `resource` | `string` Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`) Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `resource`: - `healthcare.dicomStores.dicomWebRead` |

## SetBlobStorageSettingsRequest

Request message for `SetBlobStorageSettings` method.

| Fields ||
|---|---|
| `resource` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `resource`: - `healthcare.dicomStores.dicomWebWrite` |
| `filter_config` | `` `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1#google.cloud.healthcare.v1beta1.DicomFilterConfig` `` 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}`. |
| `blob_storage_settings` | `` `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.BlobStorageSettings` `` The blob storage settings to update for the specified resources. Only fields listed in `update_mask` are applied. |

## SetBlobStorageSettingsResponse

This type has no fields.
Returns additional info in regards to a completed set blob storage settings API.

## StorageInfo

StorageInfo encapsulates all the storage info of a resource.

| Fields ||
|---|---|
| `referenced_resource` | `string` The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicom_store_id}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}` |
| `structured_storage_info` | `` `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.StructuredStorageInfo` `` Info about the data stored in structured storage for the resource. |
| `blob_storage_info` | `` `https://docs.cloud.google.com/healthcare-api/docs/reference/rpc/google.cloud.healthcare.v1beta1/storageinfo#google.cloud.healthcare.v1beta1.storageinfo.BlobStorageInfo` `` Info about the data stored in blob storage for the resource. |

## StructuredStorageInfo

StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.

| Fields ||
|---|---|
| `size_bytes` | `int64` Size in bytes of data stored in structured storage. |