Package google.cloud.healthcare.v1beta1.dicom

Index

DicomService

A service for handling collections of medical images in DICOM format.

CreateDicomStore

rpc CreateDicomStore(CreateDicomStoreRequest) returns (DicomStore)

Creates a new DICOM store within the parent dataset.

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.

DeleteDicomStore

rpc DeleteDicomStore(DeleteDicomStoreRequest) returns (Empty)

Deletes the specified DICOM store and removes all images that are contained within it.

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.

ExportDicomData

rpc ExportDicomData(ExportDicomDataRequest) returns (Operation)

Exports data to the specified destination by copying it from the DICOM store. The metadata field type is OperationMetadata.

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.

GetDicomStore

rpc GetDicomStore(GetDicomStoreRequest) returns (DicomStore)

Gets the specified DICOM store.

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.

ImportDicomData

rpc ImportDicomData(ImportDicomDataRequest) returns (Operation)

Imports data into the DICOM store by copying it from the specified source. For errors, the Operation will be populated with error details (in the form of ImportDicomDataErrorDetails in error.details), which will hold finer-grained error information. The metadata field type is OperationMetadata.

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.

ListDicomStores

rpc ListDicomStores(ListDicomStoresRequest) returns (ListDicomStoresResponse)

Lists the DICOM stores in the given dataset.

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.

UpdateDicomStore

rpc UpdateDicomStore(UpdateDicomStoreRequest) returns (DicomStore)

Updates the specified DICOM store.

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.

BigQueryDestination

The BigQuery table where the output should be written.

Fields
table_uri

string

BigQuery URI to a table, up to 2000 characters long, in the format bq://projectId.bqDatasetId.tableId

force

bool

If the destination table already exists and this flag is TRUE, the table will be overwritten by the contents of the DICOM store. If the flag is not set and the destination table already exists, the export call returns an error.

CreateDicomStoreRequest

Creates a new DICOM store.

Fields
parent

string

The name of the dataset this DICOM store belongs to.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.create

dicom_store_id

string

The ID of the DICOM store that is being created. Any string value up to 256 characters in length.

dicom_store

DicomStore

The DICOM store that should be created.

DeleteDicomStoreRequest

Deletes the specified DICOM store and removes all images that are contained within it.

Fields
name

string

The resource name of the DICOM store to delete.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.dicomStores.delete

DicomStore

Represents a DICOM store.

Fields
name

string

Output only. Resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

notification_config

NotificationConfig

Notification destination for new DICOM instances. Supplied by the client.

labels

map<string, string>

User-supplied key-value pairs used to organize DICOM stores.

Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}

Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be associated with a given store.

ExportDicomDataRequest

Exports data from the specified DICOM store. If a given resource (e.g., a DICOM object with the same SOPInstance UID) already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data will persist when the DICOM store from which it was exported is deleted.

Fields
name

string

The DICOM store resource name from which the data should be exported (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.dicomStores.export

Union field destination. Specifies the destination of the output.

To enable the Cloud Healthcare API to write to resources in your project (e.g., Cloud Storage buckets), you must give the consumer Cloud Healthcare API service account the proper permissions. The service account is: service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com. The PROJECT_NUMBER identifies the project that contains the destination Cloud Storage bucket. To get the project number, go to the GCP Console Dashboard. destination can be only one of the following:

gcs_destination

GcsDestination

The Cloud Storage output destination.

The Cloud Storage location requires the roles/storage.objectAdmin Cloud IAM role.

bigquery_destination

BigQueryDestination

The BigQuery output destination.

You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from.

The BigQuery location requires two IAM roles: roles/bigquery.dataEditor and roles/bigquery.jobUser.

GcsDestination

The Cloud Storage location where the output should be written, and the export configuration.

Fields
uri_prefix

string

The Cloud Storage destination to export to.

URI for a Cloud Storage directory where result files should be written (in the format gs://{bucket-id}/{path/to/destination/dir}). If there is no trailing slash, the service will append one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in uri_prefix.

mime_type

string

MIME types supported by DICOM spec. Each file will be written in the following format: .../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension} The frame_number component will exist only for multi-frame instances.

Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#wado-rs

The following extensions will be used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png

If unspecified, the instances will be exported in their original DICOM format.

GcsSource

Specifies the configuration for importing data from Cloud Storage.

Fields
uri

string

Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: gs://{bucket_id}/{object_id}. The URI can include wildcards in object_id and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, gs://my-bucket/my-directory/**.dcm imports all files with .dcm extensions in my-directory/ and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata.

GetDicomStoreRequest

Gets the specified DICOM store.

Fields
name

string

The resource name of the DICOM store to get.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.dicomStores.get

ImportDicomDataErrorDetails

Returns the errors encountered during DICOM store import.

Fields
sample_errors[]
(deprecated)

ErrorDetail

Deprecated. Use only for debugging purposes.

Contains sample errors encountered in imports of individual resources (for example, a Cloud Storage object).

ImportDicomDataRequest

Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API will accept duplicate DICOM instances, by simply ignoring the newly pushed instance (it will not overwrite).

Fields
name

string

The name of the DICOM store resource into which the data is imported (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.dicomStores.import

gcs_source

GcsSource

Cloud Storage source data location and import configuration.

The Cloud Storage location requires the roles/storage.objectViewer Cloud IAM role.

ListDicomStoresRequest

Lists the DICOM stores in the given dataset.

Fields
parent

string

Name of the dataset.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.list

page_size

int32

Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used.

page_token

string

The next_page_token value returned from the previous List request, if any.

filter

string

Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

ListDicomStoresResponse

Lists the DICOM stores in the given dataset.

Fields
dicom_stores[]

DicomStore

The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request.

next_page_token

string

Token to retrieve the next page of results or empty if there are no more results in the list.

UpdateDicomStoreRequest

Updates the DICOM store.

Fields
dicom_store

DicomStore

The DICOM store resource that updates the resource on the server. Only the fields listed in update_mask will be applied.

Authorization requires the following Google IAM permission on the specified resource dicomStore:

  • healthcare.dicomStores.update

update_mask

FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

หน้านี้มีประโยชน์ไหม โปรดแสดงความคิดเห็น