Package google.cloud.healthcare.v1beta1

Index

BlobStorageClass (enum)
DicomFilterConfig (message)
NotificationConfig (message)
OperationMetadata (message)
OperationMetadata.ProgressCounter (message)
PatientId (message)

BlobStorageClass

Storage classes supported for Blob objects.

Enums
`BLOB_STORAGE_CLASS_UNSPECIFIED`	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.
`STANDARD`	This stores the Object in Blob Standard Storage: https://cloud.google.com/storage/docs/storage-classes#standard
`NEARLINE`	This stores the Object in Blob Nearline Storage: https://cloud.google.com/storage/docs/storage-classes#nearline
`COLDLINE`	This stores the Object in Blob Coldline Storage: https://cloud.google.com/storage/docs/storage-classes#coldline
`ARCHIVE`	This stores the Object in Blob Archive Storage: https://cloud.google.com/storage/docs/storage-classes#archive

DicomFilterConfig

Specifies the filter configuration for DICOM resources.

Fields

Fields
Union field `filter`. `filter` can be only one of the following:
`resource_paths_gcs_uri`	`string` The Cloud Storage location of the filter configuration file. The `gcs_uri` must be in the format `gs://bucket/path/to/object`. The filter configuration file must contain a list of resource paths separated by newline characters (\n or \r\n). Each resource path must be in the format "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]" The Cloud Healthcare API service account must have the `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage location.

Union field filter.

filter can be only one of the following:

resource_paths_gcs_uri

string

The Cloud Storage location of the filter configuration file. The gcs_uri must be in the format gs://bucket/path/to/object. The filter configuration file must contain a list of resource paths separated by newline characters (\n or \r\n). Each resource path must be in the format "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]"

The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location.

NotificationConfig

Specifies where to send notifications upon changes to a data store.

Fields

Fields
`pubsub_topic`	`string` The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
`send_for_bulk_import`	`bool` Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.

pubsub_topic

string

The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail.

If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted.

Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.

send_for_bulk_import

bool

Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.

OperationMetadata

OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.

Fields
`api_method_name`	`string` The name of the API method that initiated the operation.
`create_time`	`Timestamp` The time at which the operation was created by the API.
`end_time`	`Timestamp` The time at which execution workloads were completed. Some tasks will complete after this time such as logging audit logs.
`cancel_requested`	`bool` Specifies if cancellation was requested for the operation.
`logs_url`	`string` A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at Viewing error logs in Cloud Logging. The `end_time` specified in this URL may not match the end time on the metadata because logs are written asynchronously from execution.
Union field `progress`. The progress information for the operation. Details are described in the API method that creates the operation. Not all methods provide progress information. `progress` can be only one of the following:
`counter`	`ProgressCounter`

ProgressCounter

ProgressCounter provides counters to describe an operation's progress.

Fields
`pending`	`int64` The number of units that are pending in the operation.
`success`	`int64` The number of units that succeeded in the operation.
`failure`	`int64` The number of units that failed in the operation.
`secondary_success`	`int64` The number of secondary units that succeeded in the operation.
`secondary_failure`	`int64` The number of secondary units that failed in the operation.

PatientId

A patient identifier and associated type.

Fields

Fields
`value`	`string` The patient's unique identifier.
`type`	`string` ID type. For example, MRN or NHS.

value

string

The patient's unique identifier.

type

string

ID type. For example, MRN or NHS.