| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="healthcare_v1.html">Cloud Healthcare API</a> . <a href="healthcare_v1.projects.html">projects</a> . <a href="healthcare_v1.projects.locations.html">locations</a> . <a href="healthcare_v1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1.projects.locations.datasets.dicomStores.html">dicomStores</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="healthcare_v1.projects.locations.datasets.dicomStores.studies.html">studies()</a></code> |
| </p> |
| <p class="firstline">Returns the studies Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, dicomStoreId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new DICOM store within the parent dataset.</p> |
| <p class="toc_element"> |
| <code><a href="#deidentify">deidentify(sourceStore, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">De-identifies data from the source store and writes it to the destination</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified DICOM store and removes all images that are contained</p> |
| <p class="toc_element"> |
| <code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Exports data to the specified destination by copying it from the DICOM</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the specified DICOM store.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the access control policy for a resource.</p> |
| <p class="toc_element"> |
| <code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Imports data into the DICOM store by copying it from the specified source.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the DICOM stores in the given dataset.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the specified DICOM store.</p> |
| <p class="toc_element"> |
| <code><a href="#searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</a></code></p> |
| <p class="firstline">SearchForInstances returns a list of matching instances. See</p> |
| <p class="toc_element"> |
| <code><a href="#searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</a></code></p> |
| <p class="firstline">SearchForSeries returns a list of matching series. See</p> |
| <p class="toc_element"> |
| <code><a href="#searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</a></code></p> |
| <p class="firstline">SearchForStudies returns a list of matching studies. See</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| <p class="toc_element"> |
| <code><a href="#storeInstances">storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">StoreInstances stores DICOM instances associated with study instance unique</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, dicomStoreId=None, x__xgafv=None)</code> |
| <pre>Creates a new DICOM store within the parent dataset. |
| |
| Args: |
| parent: string, The name of the dataset this DICOM store belongs to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a DICOM store. |
| "name": "A String", # Resource name of the DICOM store, of the form |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. |
| # Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "labels": { # 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}{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. |
| "a_key": "A String", |
| }, |
| } |
| |
| dicomStoreId: string, The ID of the DICOM store that is being created. |
| Any string value up to 256 characters in length. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a DICOM store. |
| "name": "A String", # Resource name of the DICOM store, of the form |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. |
| # Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "labels": { # 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}{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. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deidentify">deidentify(sourceStore, body=None, x__xgafv=None)</code> |
| <pre>De-identifies data from the source store and writes it to the destination |
| store. The metadata field type |
| is OperationMetadata. |
| If the request is successful, the |
| response field type is |
| DeidentifyDicomStoreSummary. If errors occur, |
| error is set. |
| The LRO result may still be successful if de-identification fails for some |
| DICOM instances. The output DICOM store will not contain |
| these failed resources. Failed resource totals are tracked in |
| Operation.metadata. |
| Error details are also logged to Cloud Logging |
| (see [Viewing logs](/healthcare/docs/how-tos/logging)). |
| |
| Args: |
| sourceStore: string, Source DICOM store resource name. For example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Creates a new DICOM store with sensitive information de-identified. |
| "destinationStore": "A String", # The name of the DICOM store to create and write the redacted data to. |
| # For example, |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| # |
| # * The destination dataset must exist. |
| # * The source dataset and destination dataset must both reside in the same |
| # project. De-identifying data across multiple projects is not supported. |
| # * The destination DICOM store must not exist. |
| # * The caller must have the necessary permissions to create the destination |
| # DICOM store. |
| "config": { # Configures de-id options specific to different types of content. # De-identify configuration. |
| # Each submessage customizes the handling of an |
| # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are |
| # applied in a nested manner at runtime. |
| "image": { # Specifies how to handle de-identification of image pixels. # Configures de-identification of image pixels wherever they are found in the |
| # source_dataset. |
| "textRedactionMode": "A String", # Determines how to redact text from image. |
| }, |
| "fhir": { # Specifies how to handle de-identification of a FHIR store. # Configures de-id of application/FHIR content. |
| "fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that |
| # is not matched by a FieldMetadata is passed through to the output |
| # dataset unmodified. All extensions are removed in the output. |
| { # Specifies FHIR paths to match, and how to handle de-identification of |
| # matching fields. |
| "paths": [ # List of paths to FHIR fields to be redacted. Each path is a |
| # period-separated list where each component is either a field name or |
| # FHIR type name, for example: Patient, HumanName. |
| # For "choice" types (those defined in the FHIR spec with the form: |
| # field[x]) we use two separate components. For example, |
| # "deceasedAge.unit" is matched by "Deceased.Age.unit". |
| # Supported types are: AdministrativeGenderCode, Code, Date, DateTime, |
| # Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, |
| # Xhtml. |
| # Base64Binary is also supported, but may only be kept as-is or have all |
| # the content removed. |
| "A String", |
| ], |
| "action": "A String", # Deidentify action for one field. |
| }, |
| ], |
| }, |
| "text": { # Configures de-identification of text wherever it is found in the |
| # source_dataset. |
| "transformations": [ # The transformations to apply to the detected data. |
| { # A transformation to apply to text that is identified as a specific |
| # info_type. |
| "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is # Config for date shift. |
| # consistent for a given patient and crypto key combination. |
| "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this |
| # key and the patient ID. A default key is generated for each |
| # Deidentify operation and is used wherever crypto_key is not specified. |
| }, |
| "characterMaskConfig": { # Mask a string by replacing its characters with a fixed character. # Config for character mask. |
| "maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*". |
| }, |
| "replaceWithInfoTypeConfig": { # When using the # Config for replace with InfoType. |
| # INSPECT_AND_TRANSFORM |
| # action, each match is replaced with the name of the info_type. For example, |
| # "My name is Jane" becomes "My name is [PERSON_NAME]." The |
| # TRANSFORM |
| # action is equivalent to redacting. |
| }, |
| "redactConfig": { # Define how to redact sensitive values. Default behaviour is erase. # Config for text redaction. |
| # For example, "My name is Jane." becomes "My name is ." |
| }, |
| "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, the |
| # transformation applies to any info_type. |
| "A String", |
| ], |
| "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. # Config for crypto hash. |
| # Uses SHA-256. |
| # Outputs a base64-encoded representation of the hashed output |
| # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). |
| "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this |
| # key. A default key is generated for each Deidentify operation and is used |
| # wherever crypto_key is not specified. |
| }, |
| }, |
| ], |
| }, |
| "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content. |
| "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove. |
| "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags. |
| "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta |
| # Elements, or Directory Structuring Elements, as defined at: |
| # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. |
| # They may be provided by "Keyword" or "Tag". For example "PatientID", |
| # "00100010". |
| "A String", |
| ], |
| }, |
| "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags. |
| "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta |
| # Elements, or Directory Structuring Elements, as defined at: |
| # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. |
| # They may be provided by "Keyword" or "Tag". For example "PatientID", |
| # "00100010". |
| "A String", |
| ], |
| }, |
| "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, |
| # SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. |
| # The Cloud Healthcare API regenerates these UIDs by default based on the |
| # DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly |
| # to an individual out of context, given access to the original images, or |
| # to a database of the original images containing the UIDs, it would be |
| # possible to recover the individual's identity." |
| # http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html |
| }, |
| }, |
| "filterConfig": { # Specifies the filter configuration for DICOM resources. # Filter configuration. |
| "resourcePathsGcsUri": "A 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. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the specified DICOM store and removes all images that are contained |
| within it. |
| |
| Args: |
| name: string, The resource name of the DICOM store to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="export">export(name, body=None, x__xgafv=None)</code> |
| <pre>Exports data to the specified destination by copying it from the DICOM |
| store. |
| Errors are also logged to Cloud Logging. For more information, |
| see [Viewing logs](/healthcare/docs/how-tos/logging). |
| The metadata field type is |
| OperationMetadata. |
| |
| Args: |
| name: string, The DICOM store resource name from which to export the data. For |
| example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Exports data from the specified DICOM store. |
| # If a given resource, such as 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 persists when the DICOM store from which it was |
| # exported is deleted. |
| "bigqueryDestination": { # The BigQuery table where the server writes the output. # 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`. |
| "tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long, in the format |
| # `bq://projectId.bqDatasetId.tableId` |
| "force": True or False, # If the destination table already exists and this flag is `TRUE`, the table |
| # is 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. |
| }, |
| "gcsDestination": { # The Cloud Storage location where the server writes the output and the export # The Cloud Storage output destination. |
| # |
| # The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud |
| # IAM role. |
| # configuration. |
| "uriPrefix": "A String", # The Cloud Storage destination to export to. |
| # |
| # URI for a Cloud Storage directory where the server writes the 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 in |
| # `uri_prefix`. |
| "mimeType": "A String", # MIME types supported by DICOM spec. |
| # Each file is written in the following format: |
| # `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` |
| # The frame_number component exists only for multi-frame instances. |
| # |
| # Supported MIME types are consistent with supported formats in DICOMweb: |
| # https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. |
| # Specifically, the following are supported: |
| # |
| # - application/dicom; transfer-syntax=1.2.840.10008.1.2.1 |
| # (uncompressed DICOM) |
| # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 |
| # (DICOM with embedded JPEG Baseline) |
| # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 |
| # (DICOM with embedded JPEG 2000 Lossless Only) |
| # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 |
| # (DICOM with embedded JPEG 2000) |
| # - application/dicom; transfer-syntax=* |
| # (DICOM with no transcoding) |
| # - application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 |
| # (raw uncompressed PixelData) |
| # - application/octet-stream; transfer-syntax=* |
| # (raw PixelData in whatever format it was uploaded in) |
| # - image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 |
| # (Consumer JPEG) |
| # - image/png |
| # |
| # The following extensions are used for output files: |
| # |
| # - application/dicom -> .dcm |
| # - image/jpeg -> .jpg |
| # - image/png -> .png |
| # - application/octet-stream -> no extension |
| # |
| # If unspecified, the instances are exported in the original |
| # DICOM format they were uploaded in. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets the specified DICOM store. |
| |
| Args: |
| name: string, The resource name of the DICOM store to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a DICOM store. |
| "name": "A String", # Resource name of the DICOM store, of the form |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. |
| # Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "labels": { # 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}{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. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| <pre>Gets the access control policy for a resource. |
| Returns an empty policy if the resource exists and does not have a policy |
| set. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| |
| Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| rejected. |
| |
| Requests for policies with any conditional bindings must specify version 3. |
| Policies without any conditional bindings may specify any valid value or |
| leave the field unset. |
| |
| To learn which resources support conditions in their IAM policies, see the |
| [IAM |
| documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| }, |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "logType": "A String", # The log type that this config enables. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code> |
| <pre>Imports data into the DICOM store by copying it from the specified source. |
| Errors are logged to Cloud Logging. For more information, see |
| [Viewing logs](/healthcare/docs/how-tos/logging). The |
| metadata field type is |
| OperationMetadata. |
| |
| Args: |
| name: string, The name of the DICOM store resource into which the data is imported. |
| For example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # 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. |
| "gcsSource": { # Specifies the configuration for importing data from Cloud Storage. # Cloud Storage source data location and import configuration. |
| # |
| # The Cloud Storage location requires the `roles/storage.objectViewer` |
| # Cloud IAM role. |
| "uri": "A 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. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the DICOM stores in the given dataset. |
| |
| Args: |
| parent: string, Name of the dataset. (required) |
| pageSize: integer, Limit on the number of DICOM stores to return in a single response. |
| If zero the default page size of 100 is used. |
| 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`. |
| pageToken: string, The next_page_token value returned from the previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Lists the DICOM stores in the given dataset. |
| "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more |
| # results in the list. |
| "dicomStores": [ # The returned DICOM stores. Won't be more DICOM stores than the value of |
| # page_size in the request. |
| { # Represents a DICOM store. |
| "name": "A String", # Resource name of the DICOM store, of the form |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. |
| # Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "labels": { # 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}{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. |
| "a_key": "A String", |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the specified DICOM store. |
| |
| Args: |
| name: string, Resource name of the DICOM store, of the form |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a DICOM store. |
| "name": "A String", # Resource name of the DICOM store, of the form |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. |
| # Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "labels": { # 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}{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. |
| "a_key": "A String", |
| }, |
| } |
| |
| updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, |
| see |
| https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a DICOM store. |
| "name": "A String", # Resource name of the DICOM store, of the form |
| # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. |
| "notificationConfig": { # Specifies where to send notifications upon changes to a data store. # Notification destination for new DICOM instances. |
| # Supplied by the client. |
| "pubsubTopic": "A String", # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) 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](https://cloud.google.com/pubsub/docs/overview#names) must be scoped |
| # to a project. Cloud Healthcare API service account must have publisher |
| # permissions on the given Cloud Pub/Sub topic. Not having adequate |
| # permissions causes the calls that send notifications to fail. |
| # |
| # If a notification can't be published to Cloud Pub/Sub, errors are logged to |
| # Cloud Logging (see [Viewing |
| # logs](/healthcare/docs/how-tos/logging)). If the number of |
| # errors exceeds a certain rate, some aren't submitted. |
| }, |
| "labels": { # 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}{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. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchForInstances">searchForInstances(parent, dicomWebPath, x__xgafv=None)</code> |
| <pre>SearchForInstances returns a list of matching instances. See |
| [Search Transaction] |
| (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). |
| |
| Args: |
| parent: string, The name of the DICOM store that is being accessed. For example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request. For example, |
| `instances`, `series/{series_uid}/instances`, or |
| `studies/{study_uid}/instances`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message that represents an arbitrary HTTP body. It should only be used for |
| # payload formats that can't be represented as JSON, such as raw binary or |
| # an HTML page. |
| # |
| # |
| # This message can be used both in streaming and non-streaming API methods in |
| # the request as well as the response. |
| # |
| # It can be used as a top-level request field, which is convenient if one |
| # wants to extract parameters from either the URL or HTTP template into the |
| # request fields and also want access to the raw HTTP body. |
| # |
| # Example: |
| # |
| # message GetResourceRequest { |
| # // A unique request id. |
| # string request_id = 1; |
| # |
| # // The raw HTTP body is bound to this field. |
| # google.api.HttpBody http_body = 2; |
| # } |
| # |
| # service ResourceService { |
| # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| # rpc UpdateResource(google.api.HttpBody) returns |
| # (google.protobuf.Empty); |
| # } |
| # |
| # Example with streaming methods: |
| # |
| # service CaldavService { |
| # rpc GetCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # rpc UpdateCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # } |
| # |
| # Use of this type only changes how the request and response bodies are |
| # handled, all other features will continue to work unchanged. |
| "extensions": [ # Application specific response metadata. Must be set in the first response |
| # for streaming APIs. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| "data": "A String", # The HTTP request/response body as raw binary. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchForSeries">searchForSeries(parent, dicomWebPath, x__xgafv=None)</code> |
| <pre>SearchForSeries returns a list of matching series. See |
| [Search Transaction] |
| (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). |
| |
| Args: |
| parent: string, The name of the DICOM store that is being accessed. For example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| dicomWebPath: string, The path of the SearchForSeries DICOMweb request. For example, `series` or |
| `studies/{study_uid}/series`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message that represents an arbitrary HTTP body. It should only be used for |
| # payload formats that can't be represented as JSON, such as raw binary or |
| # an HTML page. |
| # |
| # |
| # This message can be used both in streaming and non-streaming API methods in |
| # the request as well as the response. |
| # |
| # It can be used as a top-level request field, which is convenient if one |
| # wants to extract parameters from either the URL or HTTP template into the |
| # request fields and also want access to the raw HTTP body. |
| # |
| # Example: |
| # |
| # message GetResourceRequest { |
| # // A unique request id. |
| # string request_id = 1; |
| # |
| # // The raw HTTP body is bound to this field. |
| # google.api.HttpBody http_body = 2; |
| # } |
| # |
| # service ResourceService { |
| # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| # rpc UpdateResource(google.api.HttpBody) returns |
| # (google.protobuf.Empty); |
| # } |
| # |
| # Example with streaming methods: |
| # |
| # service CaldavService { |
| # rpc GetCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # rpc UpdateCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # } |
| # |
| # Use of this type only changes how the request and response bodies are |
| # handled, all other features will continue to work unchanged. |
| "extensions": [ # Application specific response metadata. Must be set in the first response |
| # for streaming APIs. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| "data": "A String", # The HTTP request/response body as raw binary. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchForStudies">searchForStudies(parent, dicomWebPath, x__xgafv=None)</code> |
| <pre>SearchForStudies returns a list of matching studies. See |
| [Search Transaction] |
| (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). |
| |
| Args: |
| parent: string, The name of the DICOM store that is being accessed. For example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| dicomWebPath: string, The path of the SearchForStudies DICOMweb request. For example, `studies`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message that represents an arbitrary HTTP body. It should only be used for |
| # payload formats that can't be represented as JSON, such as raw binary or |
| # an HTML page. |
| # |
| # |
| # This message can be used both in streaming and non-streaming API methods in |
| # the request as well as the response. |
| # |
| # It can be used as a top-level request field, which is convenient if one |
| # wants to extract parameters from either the URL or HTTP template into the |
| # request fields and also want access to the raw HTTP body. |
| # |
| # Example: |
| # |
| # message GetResourceRequest { |
| # // A unique request id. |
| # string request_id = 1; |
| # |
| # // The raw HTTP body is bound to this field. |
| # google.api.HttpBody http_body = 2; |
| # } |
| # |
| # service ResourceService { |
| # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| # rpc UpdateResource(google.api.HttpBody) returns |
| # (google.protobuf.Empty); |
| # } |
| # |
| # Example with streaming methods: |
| # |
| # service CaldavService { |
| # rpc GetCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # rpc UpdateCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # } |
| # |
| # Use of this type only changes how the request and response bodies are |
| # handled, all other features will continue to work unchanged. |
| "extensions": [ # Application specific response metadata. Must be set in the first response |
| # for streaming APIs. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| "data": "A String", # The HTTP request/response body as raw binary. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Sets the access control policy on the specified resource. Replaces any |
| existing policy. |
| |
| Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being specified. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| # the policy is limited to a few 10s of KB. An empty policy is a |
| # valid policy but certain Cloud Platform services (such as Projects) |
| # might reject them. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| }, |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "logType": "A String", # The log type that this config enables. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| ], |
| }, |
| "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only |
| # the fields in the mask will be modified. If no mask is provided, the |
| # following default mask is used: |
| # |
| # `paths: "bindings, etag"` |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| }, |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| { # Specifies the audit configuration for a service. |
| # The configuration determines which permission types are logged, and what |
| # identities, if any, are exempted from logging. |
| # An AuditConfig must have one or more AuditLogConfigs. |
| # |
| # If there are AuditConfigs for both `allServices` and a specific service, |
| # the union of the two AuditConfigs is used for that service: the log_types |
| # specified in each AuditConfig are enabled, and the exempted_members in each |
| # AuditLogConfig are exempted. |
| # |
| # Example Policy with multiple AuditConfigs: |
| # |
| # { |
| # "audit_configs": [ |
| # { |
| # "service": "allServices", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # }, |
| # { |
| # "log_type": "ADMIN_READ" |
| # } |
| # ] |
| # }, |
| # { |
| # "service": "sampleservice.googleapis.com", |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ" |
| # }, |
| # { |
| # "log_type": "DATA_WRITE", |
| # "exempted_members": [ |
| # "user:aliya@example.com" |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # |
| # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| # logging. It also exempts jose@example.com from DATA_READ logging, and |
| # aliya@example.com from DATA_WRITE logging. |
| "service": "A String", # Specifies a service that will be enabled for audit logging. |
| # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| # `allServices` is a special value that covers all services. |
| "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| { # Provides the configuration for logging a type of permissions. |
| # Example: |
| # |
| # { |
| # "audit_log_configs": [ |
| # { |
| # "log_type": "DATA_READ", |
| # "exempted_members": [ |
| # "user:jose@example.com" |
| # ] |
| # }, |
| # { |
| # "log_type": "DATA_WRITE" |
| # } |
| # ] |
| # } |
| # |
| # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting |
| # jose@example.com from DATA_READ logging. |
| "logType": "A String", # The log type that this config enables. |
| "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of |
| # permission. |
| # Follows the same format of Binding.members. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="storeInstances">storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)</code> |
| <pre>StoreInstances stores DICOM instances associated with study instance unique |
| identifiers (SUID). See |
| [Store Transaction] |
| (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). |
| |
| Args: |
| parent: string, The name of the DICOM store that is being accessed. For example, |
| `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) |
| dicomWebPath: string, The path of the StoreInstances DICOMweb request. For example, |
| `studies/[{study_uid}]`. Note that the `study_uid` is optional. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Message that represents an arbitrary HTTP body. It should only be used for |
| # payload formats that can't be represented as JSON, such as raw binary or |
| # an HTML page. |
| # |
| # |
| # This message can be used both in streaming and non-streaming API methods in |
| # the request as well as the response. |
| # |
| # It can be used as a top-level request field, which is convenient if one |
| # wants to extract parameters from either the URL or HTTP template into the |
| # request fields and also want access to the raw HTTP body. |
| # |
| # Example: |
| # |
| # message GetResourceRequest { |
| # // A unique request id. |
| # string request_id = 1; |
| # |
| # // The raw HTTP body is bound to this field. |
| # google.api.HttpBody http_body = 2; |
| # } |
| # |
| # service ResourceService { |
| # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| # rpc UpdateResource(google.api.HttpBody) returns |
| # (google.protobuf.Empty); |
| # } |
| # |
| # Example with streaming methods: |
| # |
| # service CaldavService { |
| # rpc GetCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # rpc UpdateCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # } |
| # |
| # Use of this type only changes how the request and response bodies are |
| # handled, all other features will continue to work unchanged. |
| "extensions": [ # Application specific response metadata. Must be set in the first response |
| # for streaming APIs. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| "data": "A String", # The HTTP request/response body as raw binary. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message that represents an arbitrary HTTP body. It should only be used for |
| # payload formats that can't be represented as JSON, such as raw binary or |
| # an HTML page. |
| # |
| # |
| # This message can be used both in streaming and non-streaming API methods in |
| # the request as well as the response. |
| # |
| # It can be used as a top-level request field, which is convenient if one |
| # wants to extract parameters from either the URL or HTTP template into the |
| # request fields and also want access to the raw HTTP body. |
| # |
| # Example: |
| # |
| # message GetResourceRequest { |
| # // A unique request id. |
| # string request_id = 1; |
| # |
| # // The raw HTTP body is bound to this field. |
| # google.api.HttpBody http_body = 2; |
| # } |
| # |
| # service ResourceService { |
| # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| # rpc UpdateResource(google.api.HttpBody) returns |
| # (google.protobuf.Empty); |
| # } |
| # |
| # Example with streaming methods: |
| # |
| # service CaldavService { |
| # rpc GetCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # rpc UpdateCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # } |
| # |
| # Use of this type only changes how the request and response bodies are |
| # handled, all other features will continue to work unchanged. |
| "extensions": [ # Application specific response metadata. Must be set in the first response |
| # for streaming APIs. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| "data": "A String", # The HTTP request/response body as raw binary. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| If the resource does not exist, this will return an empty set of |
| permissions, not a `NOT_FOUND` error. |
| |
| Note: This operation is designed to be used for building permission-aware |
| UIs and command-line tools, not for authorization checking. This operation |
| may "fail open" without warning. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `TestIamPermissions` method. |
| "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| # information see |
| # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
