diff --git a/clients/health_care/lib/google_api/health_care/v1/api/projects.ex b/clients/health_care/lib/google_api/health_care/v1/api/projects.ex index 4b04cb9545..ff854b1226 100644 --- a/clients/health_care/lib/google_api/health_care/v1/api/projects.ex +++ b/clients/health_care/lib/google_api/health_care/v1/api/projects.ex @@ -176,7 +176,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. @@ -190,7 +190,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:datasetId` (*type:* `String.t`) - The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:datasetId` (*type:* `String.t`) - Required. The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.Dataset.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -254,7 +254,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `sourceDataset`. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `sourceDataset`. Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `sourceDataset`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `sourceDataset`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -337,7 +337,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -415,7 +415,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -576,7 +576,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. @@ -654,7 +654,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `dataset.name`. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `dataset.name`. Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `dataset.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `dataset.name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -669,7 +669,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.Dataset.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -1513,7 +1513,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `consentStore.name`. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. + * `projects_id` (*type:* `String.t`) - Part of `consentStore.name`. Identifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. * `locations_id` (*type:* `String.t`) - Part of `consentStore.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `consentStore.name`. See documentation of `projectsId`. * `consent_stores_id` (*type:* `String.t`) - Part of `consentStore.name`. See documentation of `projectsId`. @@ -2228,7 +2228,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. + * `projects_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. Identifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. * `locations_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. See documentation of `projectsId`. * `consent_stores_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. See documentation of `projectsId`. @@ -3315,7 +3315,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `consent.name`. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. + * `projects_id` (*type:* `String.t`) - Part of `consent.name`. Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. * `locations_id` (*type:* `String.t`) - Part of `consent.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `consent.name`. See documentation of `projectsId`. * `consent_stores_id` (*type:* `String.t`) - Part of `consent.name`. See documentation of `projectsId`. @@ -4132,14 +4132,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Creates a new DICOM store within the parent dataset. + Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this DICOM store belongs to. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `data_mapper_workspaces_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4152,32 +4153,33 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:dicomStoreId` (*type:* `String.t`) - The ID of the DICOM store that is being created. Any string value up to 256 characters in length. - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DicomStore.t`) - + * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_create( + @spec healthcare_projects_locations_datasets_data_mapper_workspaces_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_create( + def healthcare_projects_locations_datasets_data_mapper_workspaces_get_iam_policy( connection, projects_id, locations_id, datasets_id, + data_mapper_workspaces_id, optional_params \\ [], opts \\ [] ) do @@ -4193,19 +4195,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :dicomStoreId => :query, - :body => :body + :"options.requestedPolicyVersion" => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:getIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dataMapperWorkspacesId" => + URI.encode(data_mapper_workspaces_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4213,19 +4216,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) end @doc """ - 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 error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `data_mapper_workspaces_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4238,15 +4241,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyDicomStoreRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_deidentify( + @spec healthcare_projects_locations_datasets_data_mapper_workspaces_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -4255,16 +4258,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_deidentify( + def healthcare_projects_locations_datasets_data_mapper_workspaces_set_iam_policy( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, + data_mapper_workspaces_id, optional_params \\ [], opts \\ [] ) do @@ -4287,12 +4290,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:setIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "dataMapperWorkspacesId" => + URI.encode(data_mapper_workspaces_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4300,19 +4304,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) end @doc """ - Deletes the specified DICOM store and removes all images that are contained within it. + 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. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the DICOM store to delete. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `data_mapper_workspaces_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4325,14 +4329,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_delete( + @spec healthcare_projects_locations_datasets_data_mapper_workspaces_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), @@ -4341,16 +4346,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} + {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_delete( + def healthcare_projects_locations_datasets_data_mapper_workspaces_test_iam_permissions( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, + data_mapper_workspaces_id, optional_params \\ [], opts \\ [] ) do @@ -4365,19 +4370,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:delete) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:testIamPermissions", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dataMapperWorkspacesId" => + URI.encode(data_mapper_workspaces_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4385,19 +4392,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}] + ) end @doc """ - 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 error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. + Creates a new DICOM store within the parent dataset. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this DICOM store belongs to. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4410,33 +4418,32 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ExportDicomDataRequest.t`) - + * `:dicomStoreId` (*type:* `String.t`) - Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length. + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DicomStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_export( + @spec healthcare_projects_locations_datasets_dicom_stores_create( Tesla.Env.client(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_export( + def healthcare_projects_locations_datasets_dicom_stores_create( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, optional_params \\ [], opts \\ [] ) do @@ -4452,6 +4459,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, + :dicomStoreId => :query, :body => :body } @@ -4459,12 +4467,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4472,19 +4479,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStore{}]) end @doc """ - Gets the specified DICOM store. + 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 error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the DICOM store to get. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Required. Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4497,14 +4504,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyDicomStoreRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_get( + @spec healthcare_projects_locations_datasets_dicom_stores_deidentify( Tesla.Env.client(), String.t(), String.t(), @@ -4513,11 +4521,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_get( + def healthcare_projects_locations_datasets_dicom_stores_deidentify( connection, projects_id, locations_id, @@ -4537,19 +4545,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4557,19 +4566,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) end @doc """ - Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + Deletes the specified DICOM store and removes all images that are contained within it. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the DICOM store to delete. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4582,15 +4591,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( + @spec healthcare_projects_locations_datasets_dicom_stores_delete( Tesla.Env.client(), String.t(), String.t(), @@ -4599,11 +4607,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( + def healthcare_projects_locations_datasets_dicom_stores_delete( connection, projects_id, locations_id, @@ -4623,20 +4631,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :"options.requestedPolicyVersion" => :query + :upload_protocol => :query } request = Request.new() - |> Request.method(:get) + |> Request.method(:delete) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getIamPolicy", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4644,16 +4651,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) end @doc """ - Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. + 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 error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -4669,7 +4676,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ImportDicomDataRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ExportDicomDataRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -4677,7 +4684,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_import( + @spec healthcare_projects_locations_datasets_dicom_stores_export( Tesla.Env.client(), String.t(), String.t(), @@ -4690,7 +4697,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_import( + def healthcare_projects_locations_datasets_dicom_stores_export( connection, projects_id, locations_id, @@ -4718,7 +4725,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -4735,14 +4742,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Lists the DICOM stores in the given dataset. + Gets the specified DICOM store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the DICOM store to get. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4755,33 +4763,32 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`. - * `:pageSize` (*type:* `integer()`) - Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. - * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_list( + @spec healthcare_projects_locations_datasets_dicom_stores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse.t()} + {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_list( + def healthcare_projects_locations_datasets_dicom_stores_get( connection, projects_id, locations_id, datasets_id, + dicom_stores_id, optional_params \\ [], opts \\ [] ) do @@ -4796,21 +4803,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :filter => :query, - :pageSize => :query, - :pageToken => :query + :upload_protocol => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4818,19 +4823,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStore{}]) end @doc """ - Updates the specified DICOM store. + Gets metrics associated with the DICOM store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `dicomStore.name`. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the DICOM store to get metrics for. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4843,16 +4848,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DicomStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStoreMetrics{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_patch( + @spec healthcare_projects_locations_datasets_dicom_stores_get_dicom_store_metrics( Tesla.Env.client(), String.t(), String.t(), @@ -4861,11 +4864,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} + {:ok, GoogleApi.HealthCare.V1.Model.DicomStoreMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_patch( + def healthcare_projects_locations_datasets_dicom_stores_get_dicom_store_metrics( connection, projects_id, locations_id, @@ -4885,21 +4888,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :updateMask => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:patch) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getDICOMStoreMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -4907,19 +4908,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStoreMetrics{}]) end @doc """ - SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -4932,14 +4933,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_search_for_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -4948,11 +4950,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_search_for_instances( + def healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( connection, projects_id, locations_id, @@ -4972,14 +4974,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :"options.requestedPolicyVersion" => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -4992,19 +4995,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) end @doc """ - SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5017,14 +5020,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ImportDicomDataRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_search_for_series( + @spec healthcare_projects_locations_datasets_dicom_stores_import( Tesla.Env.client(), String.t(), String.t(), @@ -5033,11 +5037,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_search_for_series( + def healthcare_projects_locations_datasets_dicom_stores_import( connection, projects_id, locations_id, @@ -5057,14 +5061,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -5077,19 +5082,18 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) end @doc """ - SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + Lists the DICOM stores in the given dataset. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5102,32 +5106,33 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`. + * `:pageSize` (*type:* `integer()`) - Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. + * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_search_for_studies( + @spec healthcare_projects_locations_datasets_dicom_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_search_for_studies( + def healthcare_projects_locations_datasets_dicom_stores_list( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, optional_params \\ [], opts \\ [] ) do @@ -5142,19 +5147,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :filter => :query, + :pageSize => :query, + :pageToken => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5162,19 +5169,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.ListDicomStoresResponse{}]) end @doc """ - Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + Updates the specified DICOM store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `dicomStore.name`. Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5187,15 +5194,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t`) - + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DicomStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.DicomStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( + @spec healthcare_projects_locations_datasets_dicom_stores_patch( Tesla.Env.client(), String.t(), String.t(), @@ -5204,11 +5212,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( + def healthcare_projects_locations_datasets_dicom_stores_patch( connection, projects_id, locations_id, @@ -5229,19 +5237,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, + :updateMask => :query, :body => :body } request = Request.new() - |> Request.method(:post) + |> Request.method(:patch) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5249,16 +5258,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.DicomStore{}]) end @doc """ - 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). + SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -5274,7 +5283,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -5282,7 +5290,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_store_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_search_for_instances( Tesla.Env.client(), String.t(), String.t(), @@ -5295,7 +5303,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_store_instances( + def healthcare_projects_locations_datasets_dicom_stores_search_for_instances( connection, projects_id, locations_id, @@ -5315,15 +5323,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -5340,15 +5347,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - 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. + SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5361,15 +5368,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( + @spec healthcare_projects_locations_datasets_dicom_stores_search_for_series( Tesla.Env.client(), String.t(), String.t(), @@ -5378,11 +5384,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( + def healthcare_projects_locations_datasets_dicom_stores_search_for_series( connection, projects_id, locations_id, @@ -5402,15 +5408,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -5423,22 +5428,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode( - opts ++ [struct: %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}] - ) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) end @doc """ - DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). + SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the DeleteStudy request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5455,30 +5457,28 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_search_for_studies( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_delete( + def healthcare_projects_locations_datasets_dicom_stores_search_for_studies( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -5498,15 +5498,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do request = Request.new() - |> Request.method(:delete) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5514,20 +5513,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) end @doc """ - RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). + Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5540,34 +5538,33 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( + @spec healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( + def healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -5582,20 +5579,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5603,20 +5600,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) end @doc """ - RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). + 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5629,6 +5625,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -5636,13 +5633,12 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( + @spec healthcare_projects_locations_datasets_dicom_stores_store_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -5650,13 +5646,12 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( + def healthcare_projects_locations_datasets_dicom_stores_store_instances( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -5671,20 +5666,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5696,16 +5691,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + 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. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5718,34 +5712,33 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( + def healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -5760,20 +5753,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5781,20 +5774,22 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}] + ) end @doc """ - SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + GetStudyMetrics returns metrics for a study. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. + * `projects_id` (*type:* `String.t`) - Part of `study`. Required. The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`. + * `locations_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5811,10 +5806,10 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.StudyMetrics{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( + @spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics( Tesla.Env.client(), String.t(), String.t(), @@ -5824,11 +5819,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.StudyMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( + def healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics( connection, projects_id, locations_id, @@ -5856,7 +5851,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:getStudyMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -5870,20 +5865,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.StudyMetrics{}]) end @doc """ - 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). + GetSeriesMetrics returns metrics for a series. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. + * `projects_id` (*type:* `String.t`) - Part of `series`. Required. The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`. + * `locations_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `series_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5896,35 +5892,36 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.SeriesMetrics{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.SeriesMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( + def healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, + series_id, optional_params \\ [], opts \\ [] ) do @@ -5939,21 +5936,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}:getSeriesMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5961,21 +5958,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.SeriesMetrics{}]) end @doc """ - DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). + DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the DeleteStudy request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5995,14 +5991,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -6010,14 +6005,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( + def healthcare_projects_locations_datasets_dicom_stores_studies_delete( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, optional_params \\ [], opts \\ [] ) do @@ -6039,14 +6033,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:delete) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6058,17 +6051,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). + RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6088,14 +6080,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -6103,14 +6094,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( + def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, optional_params \\ [], opts \\ [] ) do @@ -6132,14 +6122,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6151,17 +6140,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). + RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6181,14 +6169,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -6196,14 +6183,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( + def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, optional_params \\ [], opts \\ [] ) do @@ -6225,14 +6211,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6244,17 +6229,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6274,14 +6258,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -6289,14 +6272,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( + def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, optional_params \\ [], opts \\ [] ) do @@ -6318,14 +6300,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6337,18 +6318,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). + SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6365,34 +6344,30 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( + def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -6412,17 +6387,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do request = Request.new() - |> Request.method(:delete) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6430,22 +6403,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) end @doc """ - RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance). + 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6458,6 +6429,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -6465,15 +6437,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -6481,15 +6451,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( + def healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -6504,22 +6472,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6531,18 +6498,17 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). + DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`. * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6559,10 +6525,10 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( Tesla.Env.client(), String.t(), String.t(), @@ -6570,15 +6536,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( connection, projects_id, locations_id, @@ -6586,7 +6551,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do dicom_stores_id, studies_id, series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -6606,17 +6570,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do request = Request.new() - |> Request.method(:get) + |> Request.method(:delete) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6624,22 +6587,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) end @doc """ - RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). + RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`. * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6659,7 +6621,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), @@ -6667,7 +6629,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -6675,7 +6636,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( connection, projects_id, locations_id, @@ -6683,7 +6644,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do dicom_stores_id, studies_id, series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -6705,15 +6665,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6725,19 +6684,17 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). + RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`. * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6757,7 +6714,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( Tesla.Env.client(), String.t(), String.t(), @@ -6765,8 +6722,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -6774,7 +6729,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( connection, projects_id, locations_id, @@ -6782,8 +6737,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do dicom_stores_id, studies_id, series_id, - instances_id, - frames_id, optional_params \\ [], opts \\ [] ) do @@ -6805,16 +6758,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), - "framesId" => URI.encode(frames_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6826,19 +6777,17 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). + SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6858,7 +6807,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( Tesla.Env.client(), String.t(), String.t(), @@ -6866,8 +6815,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -6875,7 +6822,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( connection, projects_id, locations_id, @@ -6883,8 +6830,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do dicom_stores_id, studies_id, series_id, - instances_id, - frames_id, optional_params \\ [], opts \\ [] ) do @@ -6906,16 +6851,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), - "framesId" => URI.encode(frames_id, &URI.char_unreserved?/1) + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6927,14 +6870,18 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Creates a new FHIR store within the parent dataset. + DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this FHIR store belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6947,32 +6894,38 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:fhirStoreId` (*type:* `String.t`) - The ID of the FHIR store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.FhirStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_create( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), + String.t(), + String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_create( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( connection, projects_id, locations_id, datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, optional_params \\ [], opts \\ [] ) do @@ -6987,20 +6940,22 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :fhirStoreId => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:delete) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7008,19 +6963,22 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.FhirStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) end @doc """ - 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 DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7033,33 +6991,38 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyFhirStoreRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_deidentify( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), + String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_deidentify( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( connection, projects_id, locations_id, datasets_id, - fhir_stores_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, optional_params \\ [], opts \\ [] ) do @@ -7074,20 +7037,22 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7095,19 +7060,22 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) end @doc """ - Deletes the specified FHIR store and removes all resources within it. + RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the FHIR store to delete. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7124,28 +7092,34 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), + String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_delete( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( connection, projects_id, locations_id, datasets_id, - fhir_stores_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, optional_params \\ [], opts \\ [] ) do @@ -7165,14 +7139,17 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do request = Request.new() - |> Request.method(:delete) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7180,16 +7157,916 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + end + + @doc """ + RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + end + + @doc """ + RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + frames_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), + "framesId" => URI.encode(frames_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + end + + @doc """ + RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + frames_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), + "framesId" => URI.encode(frames_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) + end + + @doc """ + Creates a new FHIR store within the parent dataset. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this FHIR store belongs to. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:fhirStoreId` (*type:* `String.t`) - Required. The ID of the FHIR store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.FhirStore.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_create( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_create( + connection, + projects_id, + locations_id, + datasets_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :fhirStoreId => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.FhirStore{}]) + end + + @doc """ + 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 DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyFhirStoreRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_deidentify( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_deidentify( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + end + + @doc """ + Deletes the specified FHIR store and removes all resources within it. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the FHIR store to delete. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_delete( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_delete( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:delete) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) + end + + @doc """ + Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ExportResourcesRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_export( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_export( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + end + + @doc """ + Gets the configuration of the specified FHIR store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the FHIR store to get. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_get( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_get( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.FhirStore{}]) + end + + @doc """ + Gets metrics associated with the FHIR store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the FHIR store to get metrics for. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.FhirStoreMetrics{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_get_fhir_store_metrics( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.FhirStoreMetrics.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_get_fhir_store_metrics( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getFHIRStoreMetrics", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.FhirStoreMetrics{}]) + end + + @doc """ + Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :"options.requestedPolicyVersion" => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getIamPolicy", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) end @doc """ - Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -7205,7 +8082,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ExportResourcesRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ImportResourcesRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -7213,7 +8090,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_export( + @spec healthcare_projects_locations_datasets_fhir_stores_import( Tesla.Env.client(), String.t(), String.t(), @@ -7226,7 +8103,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_export( + def healthcare_projects_locations_datasets_fhir_stores_import( connection, projects_id, locations_id, @@ -7254,7 +8131,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -7271,15 +8148,102 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Gets the configuration of the specified FHIR store. + Lists the FHIR stores in the given dataset. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the FHIR store to get. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`. + * `:pageSize` (*type:* `integer()`) - Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. + * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_list( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_list( + connection, + projects_id, + locations_id, + datasets_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :filter => :query, + :pageSize => :query, + :pageToken => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse{}]) + end + + @doc """ + Updates the configuration of the specified FHIR store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `fhirStore.name`. Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7292,6 +8256,8 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.FhirStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -7299,7 +8265,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_get( + @spec healthcare_projects_locations_datasets_fhir_stores_patch( Tesla.Env.client(), String.t(), String.t(), @@ -7312,7 +8278,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_get( + def healthcare_projects_locations_datasets_fhir_stores_patch( connection, projects_id, locations_id, @@ -7332,12 +8298,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :updateMask => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:patch) |> Request.url( "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", %{ @@ -7356,15 +8324,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7377,15 +8345,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( + @spec healthcare_projects_locations_datasets_fhir_stores_rollback( Tesla.Env.client(), String.t(), String.t(), @@ -7394,11 +8362,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( + def healthcare_projects_locations_datasets_fhir_stores_rollback( connection, projects_id, locations_id, @@ -7419,14 +8387,14 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :"options.requestedPolicyVersion" => :query + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getIamPolicy", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:rollback", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -7439,19 +8407,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) end @doc """ - Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7464,15 +8432,15 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.ImportResourcesRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_import( + @spec healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -7481,11 +8449,11 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_import( + def healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( connection, projects_id, locations_id, @@ -7513,7 +8481,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -7526,18 +8494,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) end @doc """ - Lists the FHIR stores in the given dataset. + 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. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7550,33 +8519,33 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`. - * `:pageSize` (*type:* `integer()`) - Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. - * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_list( + @spec healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse.t()} + {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_list( + def healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( connection, projects_id, locations_id, datasets_id, + fhir_stores_id, optional_params \\ [], opts \\ [] ) do @@ -7592,20 +8561,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :filter => :query, - :pageSize => :query, - :pageToken => :query + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7613,19 +8581,22 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.ListFhirStoresResponse{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}] + ) end @doc """ - Updates the configuration of the specified FHIR store. + Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `fhirStore.name`. Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. Name of the `Patient` resource for which the information is required. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `patient_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7638,34 +8609,40 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.FhirStore.t`) - + * `:_count` (*type:* `integer()`) - Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. + * `:_page_token` (*type:* `String.t`) - Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. + * `:_since` (*type:* `String.t`) - Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. + * `:_type` (*type:* `String.t`) - Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple `_type` parameters isn't supported. For example, the result of `_type=Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter` instead. + * `:end` (*type:* `String.t`) - Optional. The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope. + * `:start` (*type:* `String.t`) - Optional. The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.FhirStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_patch( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.FhirStore.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_patch( + def healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + patient_id, optional_params \\ [], opts \\ [] ) do @@ -7681,20 +8658,25 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :updateMask => :query, - :body => :body + :_count => :query, + :_page_token => :query, + :_since => :query, + :_type => :query, + :end => :query, + :start => :query } request = Request.new() - |> Request.method(:patch) + |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "PatientId" => URI.encode(patient_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7702,19 +8684,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.FhirStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) end @doc """ - Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see [Deleting historical versions of a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to purge. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_id1` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7727,33 +8711,36 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_purge( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( + def healthcare_projects_locations_datasets_fhir_stores_fhir__resource_purge( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + fhir_id, + fhir_id1, optional_params \\ [], opts \\ [] ) do @@ -7768,20 +8755,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:delete) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/$purge", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "fhirId" => URI.encode(fhir_id, &URI.char_unreserved?/1), + "fhirId1" => URI.encode(fhir_id1, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7789,19 +8777,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Empty{}]) end @doc """ - 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. + Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store that holds the profiles being used for validation. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7814,33 +8803,36 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.TestIamPermissionsRequest.t`) - + * `:profile` (*type:* `String.t`) - Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_validate( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse.t()} + {:ok, GoogleApi.HealthCare.V1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( + def healthcare_projects_locations_datasets_fhir_stores_fhir__resource_validate( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + fhir_id, optional_params \\ [], opts \\ [] ) do @@ -7856,6 +8848,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, + :profile => :query, :body => :body } @@ -7863,12 +8856,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "fhirId" => URI.encode(fhir_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7876,22 +8870,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode( - opts ++ [struct: %GoogleApi.HealthCare.V1.Model.TestIamPermissionsResponse{}] - ) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.HttpBody{}]) end @doc """ - Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). + Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. Name of the `Patient` resource for which the information is required. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. Name of the FHIR store to retrieve the capabilities for. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `patient_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7904,12 +8895,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:_count` (*type:* `integer()`) - Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. - * `:_page_token` (*type:* `String.t`) - Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. - * `:_since` (*type:* `String.t`) - If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. - * `:_type` (*type:* `String.t`) - String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. - * `:end` (*type:* `String.t`) - The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope. - * `:start` (*type:* `String.t`) - The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope. * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -7917,13 +8902,12 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir_capabilities( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -7931,13 +8915,12 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( + def healthcare_projects_locations_datasets_fhir_stores_fhir_capabilities( connection, projects_id, locations_id, datasets_id, fhir_stores_id, - patient_id, optional_params \\ [], opts \\ [] ) do @@ -7952,26 +8935,19 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :_count => :query, - :_page_token => :query, - :_since => :query, - :_type => :query, - :end => :query, - :start => :query + :upload_protocol => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), - "PatientId" => URI.encode(patient_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7983,17 +8959,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see [Deleting historical versions of a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource). + Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional delete interaction, limited to searching by resource identifier. If multiple resources match, 412 Precondition Failed error will be returned. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resource is moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to purge. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_id1` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8013,14 +8988,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.Empty{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_purge( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -8028,14 +9002,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__resource_purge( + def healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_delete( connection, projects_id, locations_id, datasets_id, fhir_stores_id, fhir_id, - fhir_id1, optional_params \\ [], opts \\ [] ) do @@ -8057,14 +9030,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do Request.new() |> Request.method(:delete) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/$purge", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), - "fhirId" => URI.encode(fhir_id, &URI.char_unreserved?/1), - "fhirId1" => URI.encode(fhir_id1, &URI.char_unreserved?/1) + "fhirId" => URI.encode(fhir_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8076,16 +9048,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store that holds the profiles being used for validation. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8098,7 +9070,6 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:profile` (*type:* `String.t`) - The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -8107,7 +9078,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_validate( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_patch( Tesla.Env.client(), String.t(), String.t(), @@ -8121,7 +9092,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__resource_validate( + def healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_patch( connection, projects_id, locations_id, @@ -8143,21 +9114,20 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :profile => :query, :body => :body } request = Request.new() - |> Request.method(:post) + |> Request.method(:patch) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), - "fhirId" => URI.encode(fhir_id, &URI.char_unreserved?/1) + "fhirId" => URI.encode(fhir_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8169,15 +9139,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. + If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction, limited to searching by resource identifier. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. Name of the FHIR store to retrieve the capabilities for. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8190,6 +9161,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -8197,12 +9169,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir_capabilities( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_update( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: @@ -8210,12 +9183,13 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir_capabilities( + def healthcare_projects_locations_datasets_fhir_stores_fhir_conditional_update( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + fhir_id, optional_params \\ [], opts \\ [] ) do @@ -8230,19 +9204,21 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:put) |> Request.url( - "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "fhirId" => URI.encode(fhir_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8254,16 +9230,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). + Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store this resource belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8350,7 +9326,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -8443,7 +9419,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store in which this bundle will be executed. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store in which this bundle will be executed. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -8530,7 +9506,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -8631,7 +9607,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to update. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to update. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -8726,7 +9702,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -8814,12 +9790,12 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store to retrieve resources from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store to retrieve resources from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -8901,16 +9877,16 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store to retrieve resources from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store to retrieve resources from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `resource_type` (*type:* `String.t`) - The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * `resource_type` (*type:* `String.t`) - Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8997,7 +9973,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to update. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to update. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9092,7 +10068,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource version to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource version to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9189,7 +10165,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this HL7v2 store belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this HL7v2 store belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -9204,7 +10180,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:hl7V2StoreId` (*type:* `String.t`) - The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:hl7V2StoreId` (*type:* `String.t`) - Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.Hl7V2Store.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -9274,7 +10250,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 store to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 store to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9359,7 +10335,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9446,7 +10422,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 store to get. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 store to get. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9525,6 +10501,91 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Hl7V2Store{}]) end + @doc """ + Gets metrics associated with the HL7v2 store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics( + connection, + projects_id, + locations_id, + datasets_id, + hl7_v2_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "hl7V2StoresId" => URI.encode(hl7_v2_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics{}]) + end + @doc """ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -9618,7 +10679,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9705,7 +10766,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -9792,7 +10853,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. See documentation of `projectsId`. @@ -9808,7 +10869,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.Hl7V2Store.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -10057,7 +11118,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this message belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the HL7v2 store this message belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -10144,7 +11205,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 message to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 message to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10233,7 +11294,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 message to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 message to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10324,7 +11385,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the HL7v2 store this message belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the HL7v2 store this message belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -10411,7 +11472,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the HL7v2 store to retrieve messages from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the HL7v2 store to retrieve messages from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -10506,7 +11567,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `message.name`. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. + * `projects_id` (*type:* `String.t`) - Part of `message.name`. Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. * `locations_id` (*type:* `String.t`) - Part of `message.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `message.name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `message.name`. See documentation of `projectsId`. @@ -10523,7 +11584,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1.Model.Message.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -10766,7 +11827,7 @@ defmodule GoogleApi.HealthCare.V1.Api.Projects do end @doc """ - Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. ## Parameters diff --git a/clients/health_care/lib/google_api/health_care/v1/connection.ex b/clients/health_care/lib/google_api/health_care/v1/connection.ex index 3d9753cfe6..24b7edc024 100644 --- a/clients/health_care/lib/google_api/health_care/v1/connection.ex +++ b/clients/health_care/lib/google_api/health_care/v1/connection.ex @@ -24,6 +24,9 @@ defmodule GoogleApi.HealthCare.V1.Connection do use GoogleApi.Gax.Connection, scopes: [ + # Read, write and manage healthcare data + "https://www.googleapis.com/auth/cloud-healthcare", + # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. "https://www.googleapis.com/auth/cloud-platform" ], diff --git a/clients/health_care/lib/google_api/health_care/v1/metadata.ex b/clients/health_care/lib/google_api/health_care/v1/metadata.ex index 58a9ae5c55..8f863a9c62 100644 --- a/clients/health_care/lib/google_api/health_care/v1/metadata.ex +++ b/clients/health_care/lib/google_api/health_care/v1/metadata.ex @@ -20,7 +20,7 @@ defmodule GoogleApi.HealthCare.V1 do API client metadata for GoogleApi.HealthCare.V1. """ - @discovery_revision "20221027" + @discovery_revision "20240228" def discovery_revision(), do: @discovery_revision end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_request.ex index ec28acd41f..c0285be8cd 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_request.ex @@ -21,6 +21,7 @@ defmodule GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesRequest do ## Attributes + * `alternativeOutputFormat` (*type:* `String.t`, *default:* `nil`) - Optional. Alternative output format to be generated based on the results of analysis. * `documentContent` (*type:* `String.t`, *default:* `nil`) - document_content is a document to be annotated. * `licensedVocabularies` (*type:* `list(String.t)`, *default:* `nil`) - A list of licensed vocabularies to use in the request, in addition to the default unlicensed vocabularies. """ @@ -28,10 +29,12 @@ defmodule GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesRequest do use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ + :alternativeOutputFormat => String.t() | nil, :documentContent => String.t() | nil, :licensedVocabularies => list(String.t()) | nil } + field(:alternativeOutputFormat) field(:documentContent) field(:licensedVocabularies, type: :list) end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_response.ex b/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_response.ex index ccc3059e75..74e8e4c50b 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_response.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/analyze_entities_response.ex @@ -22,7 +22,8 @@ defmodule GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesResponse do ## Attributes * `entities` (*type:* `list(GoogleApi.HealthCare.V1.Model.Entity.t)`, *default:* `nil`) - The union of all the candidate entities that the entity_mentions in this response could link to. These are UMLS concepts or normalized mention content. - * `entityMentions` (*type:* `list(GoogleApi.HealthCare.V1.Model.EntityMention.t)`, *default:* `nil`) - entity_mentions contains all the annotated medical entities that were mentioned in the provided document. + * `entityMentions` (*type:* `list(GoogleApi.HealthCare.V1.Model.EntityMention.t)`, *default:* `nil`) - The `entity_mentions` field contains all the annotated medical entities that were mentioned in the provided document. + * `fhirBundle` (*type:* `String.t`, *default:* `nil`) - The FHIR bundle ([`R4`](http://hl7.org/fhir/R4/bundle.html)) that includes all the entities, the entity mentions, and the relationships in JSON format. * `relationships` (*type:* `list(GoogleApi.HealthCare.V1.Model.EntityMentionRelationship.t)`, *default:* `nil`) - relationships contains all the binary relationships that were identified between entity mentions within the provided document. """ @@ -31,12 +32,14 @@ defmodule GoogleApi.HealthCare.V1.Model.AnalyzeEntitiesResponse do @type t :: %__MODULE__{ :entities => list(GoogleApi.HealthCare.V1.Model.Entity.t()) | nil, :entityMentions => list(GoogleApi.HealthCare.V1.Model.EntityMention.t()) | nil, + :fhirBundle => String.t() | nil, :relationships => list(GoogleApi.HealthCare.V1.Model.EntityMentionRelationship.t()) | nil } field(:entities, as: GoogleApi.HealthCare.V1.Model.Entity, type: :list) field(:entityMentions, as: GoogleApi.HealthCare.V1.Model.EntityMention, type: :list) + field(:fhirBundle) field(:relationships, as: GoogleApi.HealthCare.V1.Model.EntityMentionRelationship, type: :list) end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/attribute_definition.ex b/clients/health_care/lib/google_api/health_care/v1/model/attribute_definition.ex index 92cd95b723..1fef5582b2 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/attribute_definition.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/attribute_definition.ex @@ -26,7 +26,7 @@ defmodule GoogleApi.HealthCare.V1.Model.AttributeDefinition do * `consentDefaultValues` (*type:* `list(String.t)`, *default:* `nil`) - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. * `dataMappingDefaultValue` (*type:* `String.t`, *default:* `nil`) - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. * `description` (*type:* `String.t`, *default:* `nil`) - Optional. A description of the attribute. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/binding.ex b/clients/health_care/lib/google_api/health_care/v1/model/binding.ex index d3f823e0c8..0737f696d4 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/binding.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/binding.ex @@ -22,8 +22,8 @@ defmodule GoogleApi.HealthCare.V1.Model.Binding do ## Attributes * `condition` (*type:* `GoogleApi.HealthCare.V1.Model.Expr.t`, *default:* `nil`) - 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 principals 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). - * `members` (*type:* `list(String.t)`, *default:* `nil`) - Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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`. - * `role` (*type:* `String.t`, *default:* `nil`) - Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * `members` (*type:* `list(String.t)`, *default:* `nil`) - Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + * `role` (*type:* `String.t`, *default:* `nil`) - Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/consent.ex b/clients/health_care/lib/google_api/health_care/v1/model/consent.ex index 39654a63d4..3aad6bda83 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/consent.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/consent.ex @@ -24,7 +24,7 @@ defmodule GoogleApi.HealthCare.V1.Model.Consent do * `consentArtifact` (*type:* `String.t`, *default:* `nil`) - Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. * `expireTime` (*type:* `DateTime.t`, *default:* `nil`) - Timestamp in UTC of when this Consent is considered expired. * `metadata` (*type:* `map()`, *default:* `nil`) - Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. * `policies` (*type:* `list(GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1ConsentPolicy.t)`, *default:* `nil`) - Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. * `revisionCreateTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The timestamp that the revision was created. * `revisionId` (*type:* `String.t`, *default:* `nil`) - Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. diff --git a/clients/health_care/lib/google_api/health_care/v1/model/consent_artifact.ex b/clients/health_care/lib/google_api/health_care/v1/model/consent_artifact.ex index daa68c9b48..b4a206be53 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/consent_artifact.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/consent_artifact.ex @@ -25,7 +25,7 @@ defmodule GoogleApi.HealthCare.V1.Model.ConsentArtifact do * `consentContentVersion` (*type:* `String.t`, *default:* `nil`) - Optional. An string indicating the version of the consent information shown to the user. * `guardianSignature` (*type:* `GoogleApi.HealthCare.V1.Model.Signature.t`, *default:* `nil`) - Optional. A signature from a guardian. * `metadata` (*type:* `map()`, *default:* `nil`) - Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. * `userId` (*type:* `String.t`, *default:* `nil`) - Required. User's UUID provided by the client. * `userSignature` (*type:* `GoogleApi.HealthCare.V1.Model.Signature.t`, *default:* `nil`) - Optional. User's signature. * `witnessSignature` (*type:* `GoogleApi.HealthCare.V1.Model.Signature.t`, *default:* `nil`) - Optional. A signature from a witness. diff --git a/clients/health_care/lib/google_api/health_care/v1/model/consent_store.ex b/clients/health_care/lib/google_api/health_care/v1/model/consent_store.ex index dd3fd8ac3e..d0233fd9d1 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/consent_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/consent_store.ex @@ -24,7 +24,7 @@ defmodule GoogleApi.HealthCare.V1.Model.ConsentStore do * `defaultConsentTtl` (*type:* `String.t`, *default:* `nil`) - Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents. * `enableConsentCreateOnUpdate` (*type:* `boolean()`, *default:* `nil`) - Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`. * `labels` (*type:* `map()`, *default:* `nil`) - Optional. User-supplied key-value pairs used to organize consent 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 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/create_message_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/create_message_request.ex index 9644611486..1e6b76354b 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/create_message_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/create_message_request.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1.Model.CreateMessageRequest do ## Attributes - * `message` (*type:* `GoogleApi.HealthCare.V1.Model.Message.t`, *default:* `nil`) - HL7v2 message. + * `message` (*type:* `GoogleApi.HealthCare.V1.Model.Message.t`, *default:* `nil`) - Required. HL7v2 message. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/dataset.ex b/clients/health_care/lib/google_api/health_care/v1/model/dataset.ex index 22cc824f61..21377c21e1 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/dataset.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/dataset.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1.Model.Dataset do ## Attributes - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `timeZone` (*type:* `String.t`, *default:* `nil`) - The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified. """ diff --git a/clients/health_care/lib/google_api/health_care/v1/model/date_shift_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/date_shift_config.ex index 91161c7164..155e567229 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/date_shift_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/date_shift_config.ex @@ -21,8 +21,8 @@ defmodule GoogleApi.HealthCare.V1.Model.DateShiftConfig do ## Attributes - * `cryptoKey` (*type:* `String.t`, *default:* `nil`) - 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 de-identification operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. - * `kmsWrapped` (*type:* `GoogleApi.HealthCare.V1.Model.KmsWrappedCryptoKey.t`, *default:* `nil`) - KMS wrapped key. Must not be set if `crypto_key` is set. + * `cryptoKey` (*type:* `String.t`, *default:* `nil`) - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if `kms_wrapped` is set. + * `kmsWrapped` (*type:* `GoogleApi.HealthCare.V1.Model.KmsWrappedCryptoKey.t`, *default:* `nil`) - KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if `crypto_key` is set. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_config.ex index f1eb36abcd..de26082fdf 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_config.ex @@ -25,6 +25,7 @@ defmodule GoogleApi.HealthCare.V1.Model.DeidentifyConfig do * `fhir` (*type:* `GoogleApi.HealthCare.V1.Model.FhirConfig.t`, *default:* `nil`) - Configures de-id of application/FHIR content. * `image` (*type:* `GoogleApi.HealthCare.V1.Model.ImageConfig.t`, *default:* `nil`) - Configures de-identification of image pixels wherever they are found in the source_dataset. * `text` (*type:* `GoogleApi.HealthCare.V1.Model.TextConfig.t`, *default:* `nil`) - Configures de-identification of text wherever it is found in the source_dataset. + * `useRegionalDataProcessing` (*type:* `boolean()`, *default:* `nil`) - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. """ use GoogleApi.Gax.ModelBase @@ -33,13 +34,15 @@ defmodule GoogleApi.HealthCare.V1.Model.DeidentifyConfig do :dicom => GoogleApi.HealthCare.V1.Model.DicomConfig.t() | nil, :fhir => GoogleApi.HealthCare.V1.Model.FhirConfig.t() | nil, :image => GoogleApi.HealthCare.V1.Model.ImageConfig.t() | nil, - :text => GoogleApi.HealthCare.V1.Model.TextConfig.t() | nil + :text => GoogleApi.HealthCare.V1.Model.TextConfig.t() | nil, + :useRegionalDataProcessing => boolean() | nil } field(:dicom, as: GoogleApi.HealthCare.V1.Model.DicomConfig) field(:fhir, as: GoogleApi.HealthCare.V1.Model.FhirConfig) field(:image, as: GoogleApi.HealthCare.V1.Model.ImageConfig) field(:text, as: GoogleApi.HealthCare.V1.Model.TextConfig) + field(:useRegionalDataProcessing) end defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.DeidentifyConfig do diff --git a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dataset_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dataset_request.ex index d6cac6213b..fa8598794b 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dataset_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dataset_request.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1.Model.DeidentifyDatasetRequest do ## Attributes * `config` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyConfig.t`, *default:* `nil`) - Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. - * `destinationDataset` (*type:* `String.t`, *default:* `nil`) - The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. + * `destinationDataset` (*type:* `String.t`, *default:* `nil`) - Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. * `gcsConfigUri` (*type:* `String.t`, *default:* `nil`) - Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. """ diff --git a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dicom_store_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dicom_store_request.ex index 90c526a8aa..65dfbc92af 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dicom_store_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_dicom_store_request.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1.Model.DeidentifyDicomStoreRequest do ## Attributes * `config` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyConfig.t`, *default:* `nil`) - Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. - * `destinationStore` (*type:* `String.t`, *default:* `nil`) - 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 location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. + * `destinationStore` (*type:* `String.t`, *default:* `nil`) - Required. 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 location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. * `filterConfig` (*type:* `GoogleApi.HealthCare.V1.Model.DicomFilterConfig.t`, *default:* `nil`) - Filter configuration. * `gcsConfigUri` (*type:* `String.t`, *default:* `nil`) - Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. """ diff --git a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_fhir_store_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_fhir_store_request.ex index d1c1284f96..a650610c73 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/deidentify_fhir_store_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/deidentify_fhir_store_request.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1.Model.DeidentifyFhirStoreRequest do ## Attributes * `config` (*type:* `GoogleApi.HealthCare.V1.Model.DeidentifyConfig.t`, *default:* `nil`) - Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. - * `destinationStore` (*type:* `String.t`, *default:* `nil`) - The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. + * `destinationStore` (*type:* `String.t`, *default:* `nil`) - Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. * `gcsConfigUri` (*type:* `String.t`, *default:* `nil`) - Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. * `resourceFilter` (*type:* `GoogleApi.HealthCare.V1.Model.FhirFilter.t`, *default:* `nil`) - A filter specifying the resources to include in the output. If not specified, all resources are included in the output. * `skipModifiedResources` (*type:* `boolean()`, *default:* `nil`) - If true, skips resources that are created or modified after the de-identify operation is created. diff --git a/clients/health_care/lib/google_api/health_care/v1/model/dicom_store.ex b/clients/health_care/lib/google_api/health_care/v1/model/dicom_store.ex index d71261128c..29e6d19ca1 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/dicom_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/dicom_store.ex @@ -22,8 +22,9 @@ defmodule GoogleApi.HealthCare.V1.Model.DicomStore do ## Attributes * `labels` (*type:* `map()`, *default:* `nil`) - 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1.Model.NotificationConfig.t`, *default:* `nil`) - Notification destination for new DICOM instances. Supplied by the client. + * `streamConfigs` (*type:* `list(GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig.t)`, *default:* `nil`) - Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. """ use GoogleApi.Gax.ModelBase @@ -31,12 +32,19 @@ defmodule GoogleApi.HealthCare.V1.Model.DicomStore do @type t :: %__MODULE__{ :labels => map() | nil, :name => String.t() | nil, - :notificationConfig => GoogleApi.HealthCare.V1.Model.NotificationConfig.t() | nil + :notificationConfig => GoogleApi.HealthCare.V1.Model.NotificationConfig.t() | nil, + :streamConfigs => + list(GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig.t()) | nil } field(:labels, type: :map) field(:name) field(:notificationConfig, as: GoogleApi.HealthCare.V1.Model.NotificationConfig) + + field(:streamConfigs, + as: GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig, + type: :list + ) end defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.DicomStore do diff --git a/clients/health_care/lib/google_api/health_care/v1/model/dicom_store_metrics.ex b/clients/health_care/lib/google_api/health_care/v1/model/dicom_store_metrics.ex new file mode 100644 index 0000000000..bd65679d2b --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/dicom_store_metrics.ex @@ -0,0 +1,61 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.DicomStoreMetrics do + @moduledoc """ + DicomStoreMetrics contains metrics describing a DICOM store. + + ## Attributes + + * `blobStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total blob storage bytes for all instances in the store. + * `instanceCount` (*type:* `String.t`, *default:* `nil`) - Number of instances in the store. + * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `seriesCount` (*type:* `String.t`, *default:* `nil`) - Number of series in the store. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total structured storage bytes for all instances in the store. + * `studyCount` (*type:* `String.t`, *default:* `nil`) - Number of studies in the store. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSizeBytes => String.t() | nil, + :instanceCount => String.t() | nil, + :name => String.t() | nil, + :seriesCount => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil, + :studyCount => String.t() | nil + } + + field(:blobStorageSizeBytes) + field(:instanceCount) + field(:name) + field(:seriesCount) + field(:structuredStorageSizeBytes) + field(:studyCount) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.DicomStoreMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.DicomStoreMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.DicomStoreMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/entity_mention.ex b/clients/health_care/lib/google_api/health_care/v1/model/entity_mention.ex index 2583f38828..f82049254f 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/entity_mention.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/entity_mention.ex @@ -23,7 +23,7 @@ defmodule GoogleApi.HealthCare.V1.Model.EntityMention do * `certaintyAssessment` (*type:* `GoogleApi.HealthCare.V1.Model.Feature.t`, *default:* `nil`) - The certainty assessment of the entity mention. Its value is one of: LIKELY, SOMEWHAT_LIKELY, UNCERTAIN, SOMEWHAT_UNLIKELY, UNLIKELY, CONDITIONAL * `confidence` (*type:* `float()`, *default:* `nil`) - The model's confidence in this entity mention annotation. A number between 0 and 1. - * `linkedEntities` (*type:* `list(GoogleApi.HealthCare.V1.Model.LinkedEntity.t)`, *default:* `nil`) - linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence.it + * `linkedEntities` (*type:* `list(GoogleApi.HealthCare.V1.Model.LinkedEntity.t)`, *default:* `nil`) - linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence. * `mentionId` (*type:* `String.t`, *default:* `nil`) - mention_id uniquely identifies each entity mention in a single response. * `subject` (*type:* `GoogleApi.HealthCare.V1.Model.Feature.t`, *default:* `nil`) - The subject this entity mention relates to. Its value is one of: PATIENT, FAMILY_MEMBER, OTHER * `temporalAssessment` (*type:* `GoogleApi.HealthCare.V1.Model.Feature.t`, *default:* `nil`) - How this entity mention relates to the subject temporally. Its value is one of: CURRENT, CLINICAL_HISTORY, FAMILY_HISTORY, UPCOMING, ALLERGY diff --git a/clients/health_care/lib/google_api/health_care/v1/model/export_messages_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/export_messages_request.ex index ead7cbe12d..2633b5bb75 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/export_messages_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/export_messages_request.ex @@ -22,7 +22,9 @@ defmodule GoogleApi.HealthCare.V1.Model.ExportMessagesRequest do ## Attributes * `endTime` (*type:* `DateTime.t`, *default:* `nil`) - The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used. This value has to come after the `start_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. + * `filter` (*type:* `String.t`, *default:* `nil`) - Restricts messages exported to those matching a filter, only applicable to PubsubDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the `yyyy-mm-dd` date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range. * `gcsDestination` (*type:* `GoogleApi.HealthCare.V1.Model.GcsDestination.t`, *default:* `nil`) - Export to a Cloud Storage destination. + * `pubsubDestination` (*type:* `GoogleApi.HealthCare.V1.Model.PubsubDestination.t`, *default:* `nil`) - Export messages to a Pub/Sub topic. * `startTime` (*type:* `DateTime.t`, *default:* `nil`) - The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. """ @@ -30,12 +32,16 @@ defmodule GoogleApi.HealthCare.V1.Model.ExportMessagesRequest do @type t :: %__MODULE__{ :endTime => DateTime.t() | nil, + :filter => String.t() | nil, :gcsDestination => GoogleApi.HealthCare.V1.Model.GcsDestination.t() | nil, + :pubsubDestination => GoogleApi.HealthCare.V1.Model.PubsubDestination.t() | nil, :startTime => DateTime.t() | nil } field(:endTime, as: DateTime) + field(:filter) field(:gcsDestination, as: GoogleApi.HealthCare.V1.Model.GcsDestination) + field(:pubsubDestination, as: GoogleApi.HealthCare.V1.Model.PubsubDestination) field(:startTime, as: DateTime) end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/fhir_notification_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/fhir_notification_config.ex new file mode 100644 index 0000000000..38833df31d --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/fhir_notification_config.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.FhirNotificationConfig do + @moduledoc """ + Contains the configuration for FHIR notifications. + + ## Attributes + + * `pubsubTopic` (*type:* `String.t`, *default:* `nil`) - The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that 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. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + * `sendFullResource` (*type:* `boolean()`, *default:* `nil`) - Whether to send full FHIR resource to this Pub/Sub topic. + * `sendPreviousResourceOnDelete` (*type:* `boolean()`, *default:* `nil`) - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :pubsubTopic => String.t() | nil, + :sendFullResource => boolean() | nil, + :sendPreviousResourceOnDelete => boolean() | nil + } + + field(:pubsubTopic) + field(:sendFullResource) + field(:sendPreviousResourceOnDelete) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.FhirNotificationConfig do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.FhirNotificationConfig.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.FhirNotificationConfig do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/fhir_store.ex b/clients/health_care/lib/google_api/health_care/v1/model/fhir_store.ex index db9df4b10a..01640de5ca 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/fhir_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/fhir_store.ex @@ -27,11 +27,12 @@ defmodule GoogleApi.HealthCare.V1.Model.FhirStore do * `disableResourceVersioning` (*type:* `boolean()`, *default:* `nil`) - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. * `enableUpdateCreate` (*type:* `boolean()`, *default:* `nil`) - Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. * `labels` (*type:* `map()`, *default:* `nil`) - User-supplied key-value pairs used to organize FHIR 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1.Model.NotificationConfig.t`, *default:* `nil`) - If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". + * `name` (*type:* `String.t`, *default:* `nil`) - Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1.Model.NotificationConfig.t`, *default:* `nil`) - Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". + * `notificationConfigs` (*type:* `list(GoogleApi.HealthCare.V1.Model.FhirNotificationConfig.t)`, *default:* `nil`) - Specifies where and whether to send notifications upon changes to a FHIR store. * `streamConfigs` (*type:* `list(GoogleApi.HealthCare.V1.Model.StreamConfig.t)`, *default:* `nil`) - A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. * `validationConfig` (*type:* `GoogleApi.HealthCare.V1.Model.ValidationConfig.t`, *default:* `nil`) - Configuration for how to validate incoming FHIR resources against configured profiles. - * `version` (*type:* `String.t`, *default:* `nil`) - Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. + * `version` (*type:* `String.t`, *default:* `nil`) - Required. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. """ use GoogleApi.Gax.ModelBase @@ -45,6 +46,8 @@ defmodule GoogleApi.HealthCare.V1.Model.FhirStore do :labels => map() | nil, :name => String.t() | nil, :notificationConfig => GoogleApi.HealthCare.V1.Model.NotificationConfig.t() | nil, + :notificationConfigs => + list(GoogleApi.HealthCare.V1.Model.FhirNotificationConfig.t()) | nil, :streamConfigs => list(GoogleApi.HealthCare.V1.Model.StreamConfig.t()) | nil, :validationConfig => GoogleApi.HealthCare.V1.Model.ValidationConfig.t() | nil, :version => String.t() | nil @@ -58,6 +61,12 @@ defmodule GoogleApi.HealthCare.V1.Model.FhirStore do field(:labels, type: :map) field(:name) field(:notificationConfig, as: GoogleApi.HealthCare.V1.Model.NotificationConfig) + + field(:notificationConfigs, + as: GoogleApi.HealthCare.V1.Model.FhirNotificationConfig, + type: :list + ) + field(:streamConfigs, as: GoogleApi.HealthCare.V1.Model.StreamConfig, type: :list) field(:validationConfig, as: GoogleApi.HealthCare.V1.Model.ValidationConfig) field(:version) diff --git a/clients/health_care/lib/google_api/health_care/v1/model/fhir_store_metric.ex b/clients/health_care/lib/google_api/health_care/v1/model/fhir_store_metric.ex new file mode 100644 index 0000000000..f97c2450af --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/fhir_store_metric.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.FhirStoreMetric do + @moduledoc """ + Count of resources and total storage size by type for a given FHIR store. + + ## Attributes + + * `count` (*type:* `String.t`, *default:* `nil`) - The total count of FHIR resources in the store of this resource type. + * `resourceType` (*type:* `String.t`, *default:* `nil`) - The FHIR resource type this metric applies to. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - The total amount of structured storage used by FHIR resources of this resource type in the store. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :count => String.t() | nil, + :resourceType => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil + } + + field(:count) + field(:resourceType) + field(:structuredStorageSizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.FhirStoreMetric do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.FhirStoreMetric.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.FhirStoreMetric do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/fhir_store_metrics.ex b/clients/health_care/lib/google_api/health_care/v1/model/fhir_store_metrics.ex new file mode 100644 index 0000000000..79c5074806 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/fhir_store_metrics.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.FhirStoreMetrics do + @moduledoc """ + List of metrics for a given FHIR store. + + ## Attributes + + * `metrics` (*type:* `list(GoogleApi.HealthCare.V1.Model.FhirStoreMetric.t)`, *default:* `nil`) - List of FhirStoreMetric by resource type. + * `name` (*type:* `String.t`, *default:* `nil`) - The resource name of the FHIR store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :metrics => list(GoogleApi.HealthCare.V1.Model.FhirStoreMetric.t()) | nil, + :name => String.t() | nil + } + + field(:metrics, as: GoogleApi.HealthCare.V1.Model.FhirStoreMetric, type: :list) + field(:name) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.FhirStoreMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.FhirStoreMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.FhirStoreMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/google_cloud_healthcare_v1_dicom_stream_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/google_cloud_healthcare_v1_dicom_stream_config.ex new file mode 100644 index 0000000000..1332485c55 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/google_cloud_healthcare_v1_dicom_stream_config.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig do + @moduledoc """ + StreamConfig specifies configuration for a streaming DICOM export. + + ## Attributes + + * `bigqueryDestination` (*type:* `GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomBigQueryDestination.t`, *default:* `nil`) - Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :bigqueryDestination => + GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomBigQueryDestination.t() + | nil + } + + field(:bigqueryDestination, + as: GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomBigQueryDestination + ) +end + +defimpl Poison.Decoder, + for: GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig.decode(value, options) + end +end + +defimpl Poison.Encoder, + for: GoogleApi.HealthCare.V1.Model.GoogleCloudHealthcareV1DicomStreamConfig do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store.ex b/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store.ex index 999976455c..a364794cca 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1.Model.Hl7V2Store do ## Attributes * `labels` (*type:* `map()`, *default:* `nil`) - User-supplied key-value pairs used to organize HL7v2 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. * `notificationConfigs` (*type:* `list(GoogleApi.HealthCare.V1.Model.Hl7V2NotificationConfig.t)`, *default:* `nil`) - A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. * `parserConfig` (*type:* `GoogleApi.HealthCare.V1.Model.ParserConfig.t`, *default:* `nil`) - The configuration for the parser. It determines how the server parses the messages. * `rejectDuplicateMessage` (*type:* `boolean()`, *default:* `nil`) - Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. diff --git a/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store_metric.ex b/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store_metric.ex new file mode 100644 index 0000000000..c78540e988 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store_metric.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric do + @moduledoc """ + Count of messages and total storage size by type for a given HL7 store. + + ## Attributes + + * `count` (*type:* `String.t`, *default:* `nil`) - The total count of HL7v2 messages in the store for the given message type. + * `messageType` (*type:* `String.t`, *default:* `nil`) - The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - The total amount of structured storage used by HL7v2 messages of this message type in the store. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :count => String.t() | nil, + :messageType => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil + } + + field(:count) + field(:messageType) + field(:structuredStorageSizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store_metrics.ex b/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store_metrics.ex new file mode 100644 index 0000000000..9d360e820f --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/hl7_v2_store_metrics.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics do + @moduledoc """ + List of metrics for a given HL7v2 store. + + ## Attributes + + * `metrics` (*type:* `list(GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric.t)`, *default:* `nil`) - List of HL7v2 store metrics by message type. + * `name` (*type:* `String.t`, *default:* `nil`) - The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :metrics => list(GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric.t()) | nil, + :name => String.t() | nil + } + + field(:metrics, as: GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetric, type: :list) + field(:name) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.Hl7V2StoreMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/ingest_message_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/ingest_message_request.ex index 40df1785cb..b517cfaa4c 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/ingest_message_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/ingest_message_request.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1.Model.IngestMessageRequest do ## Attributes - * `message` (*type:* `GoogleApi.HealthCare.V1.Model.Message.t`, *default:* `nil`) - HL7v2 message to ingest. + * `message` (*type:* `GoogleApi.HealthCare.V1.Model.Message.t`, *default:* `nil`) - Required. HL7v2 message to ingest. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/location.ex b/clients/health_care/lib/google_api/health_care/v1/model/location.ex index dc49707e6b..67b8585c04 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/location.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/location.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1.Model.Location do @moduledoc """ - A resource that represents Google Cloud Platform location. + A resource that represents a Google Cloud location. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1/model/message.ex b/clients/health_care/lib/google_api/health_care/v1/model/message.ex index f180e25aec..cd6c0d2ef2 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/message.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/message.ex @@ -22,10 +22,10 @@ defmodule GoogleApi.HealthCare.V1.Model.Message do ## Attributes * `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The datetime when the message was created. Set by the server. - * `data` (*type:* `String.t`, *default:* `nil`) - Raw message bytes. + * `data` (*type:* `String.t`, *default:* `nil`) - Required. Raw message bytes. * `labels` (*type:* `map()`, *default:* `nil`) - User-supplied key-value pairs used to organize HL7v2 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. * `messageType` (*type:* `String.t`, *default:* `nil`) - The message type for this message. MSH-9.1. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. + * `name` (*type:* `String.t`, *default:* `nil`) - Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. * `parsedData` (*type:* `GoogleApi.HealthCare.V1.Model.ParsedData.t`, *default:* `nil`) - Output only. The parsed version of the raw message data. * `patientIds` (*type:* `list(GoogleApi.HealthCare.V1.Model.PatientId.t)`, *default:* `nil`) - All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. * `schematizedData` (*type:* `GoogleApi.HealthCare.V1.Model.SchematizedData.t`, *default:* `nil`) - The parsed version of the raw message data schematized according to this store's schemas and type definitions. diff --git a/clients/health_care/lib/google_api/health_care/v1/model/notification_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/notification_config.ex index 782fc59fc4..5c1fab13bb 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/notification_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/notification_config.ex @@ -22,15 +22,18 @@ defmodule GoogleApi.HealthCare.V1.Model.NotificationConfig do ## Attributes * `pubsubTopic` (*type:* `String.t`, *default:* `nil`) - The [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 Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. + * `sendForBulkImport` (*type:* `boolean()`, *default:* `nil`) - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. """ use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ - :pubsubTopic => String.t() | nil + :pubsubTopic => String.t() | nil, + :sendForBulkImport => boolean() | nil } field(:pubsubTopic) + field(:sendForBulkImport) end defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.NotificationConfig do diff --git a/clients/health_care/lib/google_api/health_care/v1/model/operation.ex b/clients/health_care/lib/google_api/health_care/v1/model/operation.ex index 56bad4aec6..c45b3d3882 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/operation.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/operation.ex @@ -25,7 +25,7 @@ defmodule GoogleApi.HealthCare.V1.Model.Operation do * `error` (*type:* `GoogleApi.HealthCare.V1.Model.Status.t`, *default:* `nil`) - The error result of the operation in case of failure or cancellation. * `metadata` (*type:* `map()`, *default:* `nil`) - 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. * `name` (*type:* `String.t`, *default:* `nil`) - 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` (*type:* `map()`, *default:* `nil`) - 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`. + * `response` (*type:* `map()`, *default:* `nil`) - The normal, successful response of the operation. 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`. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/policy.ex b/clients/health_care/lib/google_api/health_care/v1/model/policy.ex index 79ceb4dfd7..e449cf77fa 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/policy.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/policy.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1.Model.Policy do @moduledoc """ - 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`, or principals, to a single `role`. Principals 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/). + 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`, or principals, to a single `role`. Principals 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/). ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1/model/pubsub_destination.ex b/clients/health_care/lib/google_api/health_care/v1/model/pubsub_destination.ex new file mode 100644 index 0000000000..1e82497a61 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/pubsub_destination.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.PubsubDestination do + @moduledoc """ + The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic. + + ## Attributes + + * `pubsubTopic` (*type:* `String.t`, *default:* `nil`) - The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :pubsubTopic => String.t() | nil + } + + field(:pubsubTopic) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.PubsubDestination do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.PubsubDestination.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.PubsubDestination do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resource_filtering_fields.ex b/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resource_filtering_fields.ex new file mode 100644 index 0000000000..f7b8aaf9ce --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resource_filtering_fields.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields do + @moduledoc """ + + + ## Attributes + + * `metadataFilter` (*type:* `String.t`, *default:* `nil`) - Optional. A filter expression that matches data in the `Resource.meta` element. Supports all filters in [AIP-160](https://google.aip.dev/160) except the "has" (`:`) operator. Supports the following custom functions: * `tag("") = ""` for tag filtering. * `extension_value_ts("") = ` for filtering extensions with a timestamp, where `` is a Unix timestamp. Supports the `>`, `<`, `<=`, `>=`, and `!=` comparison operators. + * `operationIds` (*type:* `list(String.t)`, *default:* `nil`) - Optional. A list of operation IDs to roll back. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :metadataFilter => String.t() | nil, + :operationIds => list(String.t()) | nil + } + + field(:metadataFilter) + field(:operationIds, type: :list) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resources_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resources_request.ex new file mode 100644 index 0000000000..ffc3ce5e6a --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resources_request.ex @@ -0,0 +1,68 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesRequest do + @moduledoc """ + + + ## Attributes + + * `changeType` (*type:* `String.t`, *default:* `nil`) - Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. + * `excludeRollbacks` (*type:* `boolean()`, *default:* `nil`) - Optional. Specifies whether to exclude earlier rollbacks. + * `filteringFields` (*type:* `GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields.t`, *default:* `nil`) - Optional. Parameters for filtering resources + * `force` (*type:* `boolean()`, *default:* `nil`) - Optional. When enabled, changes will be reverted without explicit confirmation + * `inputGcsObject` (*type:* `String.t`, *default:* `nil`) - Optional. GCS object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted + * `resultGcsBucket` (*type:* `String.t`, *default:* `nil`) - Required. Bucket to deposit result + * `rollbackTime` (*type:* `DateTime.t`, *default:* `nil`) - Required. Time point to rollback to. + * `type` (*type:* `list(String.t)`, *default:* `nil`) - Optional. If specified, revert only resources of these types + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :changeType => String.t() | nil, + :excludeRollbacks => boolean() | nil, + :filteringFields => + GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields.t() | nil, + :force => boolean() | nil, + :inputGcsObject => String.t() | nil, + :resultGcsBucket => String.t() | nil, + :rollbackTime => DateTime.t() | nil, + :type => list(String.t()) | nil + } + + field(:changeType) + field(:excludeRollbacks) + field(:filteringFields, as: GoogleApi.HealthCare.V1.Model.RollbackFhirResourceFilteringFields) + field(:force) + field(:inputGcsObject) + field(:resultGcsBucket) + field(:rollbackTime, as: DateTime) + field(:type, type: :list) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesRequest do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesRequest.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesRequest do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resources_response.ex b/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resources_response.ex new file mode 100644 index 0000000000..1078cf5df2 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/rollback_fhir_resources_response.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesResponse do + @moduledoc """ + Final response of rollback FIHR resources request. + + ## Attributes + + * `fhirStore` (*type:* `String.t`, *default:* `nil`) - The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :fhirStore => String.t() | nil + } + + field(:fhirStore) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesResponse do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesResponse.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.RollbackFhirResourcesResponse do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/schema_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/schema_config.ex index 944f288421..001e7e0da8 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/schema_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/schema_config.ex @@ -21,6 +21,7 @@ defmodule GoogleApi.HealthCare.V1.Model.SchemaConfig do ## Attributes + * `lastUpdatedPartitionConfig` (*type:* `GoogleApi.HealthCare.V1.Model.TimePartitioning.t`, *default:* `nil`) - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. * `recursiveStructureDepth` (*type:* `String.t`, *default:* `nil`) - The depth for all recursive structures in the output analytics schema. For example, `concept` in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called `concept.concept` but not `concept.concept.concept`. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. * `schemaType` (*type:* `String.t`, *default:* `nil`) - Specifies the output schema type. Schema type is required. """ @@ -28,10 +29,12 @@ defmodule GoogleApi.HealthCare.V1.Model.SchemaConfig do use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ + :lastUpdatedPartitionConfig => GoogleApi.HealthCare.V1.Model.TimePartitioning.t() | nil, :recursiveStructureDepth => String.t() | nil, :schemaType => String.t() | nil } + field(:lastUpdatedPartitionConfig, as: GoogleApi.HealthCare.V1.Model.TimePartitioning) field(:recursiveStructureDepth) field(:schemaType) end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/search_resources_request.ex b/clients/health_care/lib/google_api/health_care/v1/model/search_resources_request.ex index af4909f2a6..4f84483448 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/search_resources_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/search_resources_request.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1.Model.SearchResourcesRequest do ## Attributes - * `resourceType` (*type:* `String.t`, *default:* `nil`) - The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * `resourceType` (*type:* `String.t`, *default:* `nil`) - Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1/model/series_metrics.ex b/clients/health_care/lib/google_api/health_care/v1/model/series_metrics.ex new file mode 100644 index 0000000000..d60f473930 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/series_metrics.ex @@ -0,0 +1,55 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.SeriesMetrics do + @moduledoc """ + SeriesMetrics contains metrics describing a DICOM series. + + ## Attributes + + * `blobStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total blob storage bytes for all instances in the series. + * `instanceCount` (*type:* `String.t`, *default:* `nil`) - Number of instances in the series. + * `series` (*type:* `String.t`, *default:* `nil`) - The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total structured storage bytes for all instances in the series. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSizeBytes => String.t() | nil, + :instanceCount => String.t() | nil, + :series => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil + } + + field(:blobStorageSizeBytes) + field(:instanceCount) + field(:series) + field(:structuredStorageSizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.SeriesMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.SeriesMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.SeriesMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/study_metrics.ex b/clients/health_care/lib/google_api/health_care/v1/model/study_metrics.ex new file mode 100644 index 0000000000..ace8094000 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/study_metrics.ex @@ -0,0 +1,58 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.StudyMetrics do + @moduledoc """ + StudyMetrics contains metrics describing a DICOM study. + + ## Attributes + + * `blobStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total blob storage bytes for all instances in the study. + * `instanceCount` (*type:* `String.t`, *default:* `nil`) - Number of instances in the study. + * `seriesCount` (*type:* `String.t`, *default:* `nil`) - Number of series in the study. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total structured storage bytes for all instances in the study. + * `study` (*type:* `String.t`, *default:* `nil`) - The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSizeBytes => String.t() | nil, + :instanceCount => String.t() | nil, + :seriesCount => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil, + :study => String.t() | nil + } + + field(:blobStorageSizeBytes) + field(:instanceCount) + field(:seriesCount) + field(:structuredStorageSizeBytes) + field(:study) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.StudyMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.StudyMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.StudyMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/text_config.ex b/clients/health_care/lib/google_api/health_care/v1/model/text_config.ex index 4735c41346..caa5e268b2 100644 --- a/clients/health_care/lib/google_api/health_care/v1/model/text_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1/model/text_config.ex @@ -21,15 +21,26 @@ defmodule GoogleApi.HealthCare.V1.Model.TextConfig do ## Attributes - * `transformations` (*type:* `list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t)`, *default:* `nil`) - The transformations to apply to the detected data. + * `additionalTransformations` (*type:* `list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t)`, *default:* `nil`) - Transformations to apply to the detected data, overridden by `exclude_info_types`. + * `excludeInfoTypes` (*type:* `list(String.t)`, *default:* `nil`) - InfoTypes to skip transforming, overriding `additional_transformations`. + * `transformations` (*type:* `list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t)`, *default:* `nil`) - The transformations to apply to the detected data. Deprecated. Use `additional_transformations` instead. """ use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ + :additionalTransformations => + list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t()) | nil, + :excludeInfoTypes => list(String.t()) | nil, :transformations => list(GoogleApi.HealthCare.V1.Model.InfoTypeTransformation.t()) | nil } + field(:additionalTransformations, + as: GoogleApi.HealthCare.V1.Model.InfoTypeTransformation, + type: :list + ) + + field(:excludeInfoTypes, type: :list) field(:transformations, as: GoogleApi.HealthCare.V1.Model.InfoTypeTransformation, type: :list) end diff --git a/clients/health_care/lib/google_api/health_care/v1/model/time_partitioning.ex b/clients/health_care/lib/google_api/health_care/v1/model/time_partitioning.ex new file mode 100644 index 0000000000..f061ba49dd --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1/model/time_partitioning.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1.Model.TimePartitioning do + @moduledoc """ + Configuration for FHIR BigQuery time-partitioned tables. + + ## Attributes + + * `expirationMs` (*type:* `String.t`, *default:* `nil`) - Number of milliseconds for which to keep the storage for a partition. + * `type` (*type:* `String.t`, *default:* `nil`) - Type of partitioning. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :expirationMs => String.t() | nil, + :type => String.t() | nil + } + + field(:expirationMs) + field(:type) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1.Model.TimePartitioning do + def decode(value, options) do + GoogleApi.HealthCare.V1.Model.TimePartitioning.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1.Model.TimePartitioning do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/api/projects.ex b/clients/health_care/lib/google_api/health_care/v1beta1/api/projects.ex index e3aa669487..9c4494f260 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/api/projects.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/api/projects.ex @@ -178,7 +178,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. @@ -192,7 +192,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:datasetId` (*type:* `String.t`) - The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:datasetId` (*type:* `String.t`) - Required. The ID of the dataset that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Dataset.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -256,7 +256,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `sourceDataset`. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `sourceDataset`. Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `sourceDataset`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `sourceDataset`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -339,7 +339,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -420,7 +420,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -584,7 +584,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. @@ -664,7 +664,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `dataset.name`. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `projects_id` (*type:* `String.t`) - Part of `dataset.name`. Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `locations_id` (*type:* `String.t`) - Part of `dataset.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `dataset.name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -679,7 +679,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Dataset.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -917,7 +917,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this Annotation store belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this Annotation store belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -932,7 +932,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:annotationStoreId` (*type:* `String.t`) - The ID of the Annotation store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:annotationStoreId` (*type:* `String.t`) - Required. The ID of the Annotation store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.AnnotationStore.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -1002,7 +1002,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the Annotation store to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the Annotation store to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -1088,7 +1088,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -1175,7 +1175,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -1262,7 +1262,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the Annotation store to get. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the Annotation store to get. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -1435,7 +1435,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -1522,7 +1522,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -1611,7 +1611,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `annotationStore.name`. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `annotationStore.name`. Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `annotationStore.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `annotationStore.name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `annotationStore.name`. See documentation of `projectsId`. @@ -1627,7 +1627,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.AnnotationStore.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -1877,7 +1877,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -1964,7 +1964,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the Annotation to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the Annotation to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -2053,7 +2053,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the Annotation to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the Annotation to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -2142,7 +2142,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the Annotation store to retrieve Annotations from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the Annotation store to retrieve Annotations from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -2237,7 +2237,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `annotation.name`. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + * `projects_id` (*type:* `String.t`) - Part of `annotation.name`. Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. * `locations_id` (*type:* `String.t`) - Part of `annotation.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `annotation.name`. See documentation of `projectsId`. * `annotation_stores_id` (*type:* `String.t`) - Part of `annotation.name`. See documentation of `projectsId`. @@ -2254,7 +2254,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Annotation.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -3660,7 +3660,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. + * `projects_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. Identifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. * `locations_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. See documentation of `projectsId`. * `consent_stores_id` (*type:* `String.t`) - Part of `attributeDefinition.name`. See documentation of `projectsId`. @@ -4751,7 +4751,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `consent.name`. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. + * `projects_id` (*type:* `String.t`) - Part of `consent.name`. Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. * `locations_id` (*type:* `String.t`) - Part of `consent.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `consent.name`. See documentation of `projectsId`. * `consent_stores_id` (*type:* `String.t`) - Part of `consent.name`. See documentation of `projectsId`. @@ -5568,14 +5568,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Creates a new DICOM store within the parent dataset. + Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this DICOM store belongs to. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `data_mapper_workspaces_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5588,32 +5589,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:dicomStoreId` (*type:* `String.t`) - The ID of the DICOM store that is being created. Any string value up to 256 characters in length. - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DicomStore.t`) - + * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_create( + @spec healthcare_projects_locations_datasets_data_mapper_workspaces_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStore.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_create( + def healthcare_projects_locations_datasets_data_mapper_workspaces_get_iam_policy( connection, projects_id, locations_id, datasets_id, + data_mapper_workspaces_id, optional_params \\ [], opts \\ [] ) do @@ -5629,19 +5631,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :dicomStoreId => :query, - :body => :body + :"options.requestedPolicyVersion" => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:getIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dataMapperWorkspacesId" => + URI.encode(data_mapper_workspaces_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5649,19 +5652,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) end @doc """ - 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. 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. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). + Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `data_mapper_workspaces_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5674,15 +5677,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyDicomStoreRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_deidentify( + @spec healthcare_projects_locations_datasets_data_mapper_workspaces_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -5691,16 +5694,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_deidentify( + def healthcare_projects_locations_datasets_data_mapper_workspaces_set_iam_policy( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, + data_mapper_workspaces_id, optional_params \\ [], opts \\ [] ) do @@ -5723,12 +5726,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:setIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "dataMapperWorkspacesId" => + URI.encode(data_mapper_workspaces_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5736,19 +5740,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) end @doc """ - Deletes the specified DICOM store and removes all images that are contained within it. + 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. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the DICOM store to delete. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `data_mapper_workspaces_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5761,14 +5765,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Empty{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_delete( + @spec healthcare_projects_locations_datasets_data_mapper_workspaces_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), @@ -5777,16 +5782,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Empty.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_delete( + def healthcare_projects_locations_datasets_data_mapper_workspaces_test_iam_permissions( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, + data_mapper_workspaces_id, optional_params \\ [], opts \\ [] ) do @@ -5801,19 +5806,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:delete) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:testIamPermissions", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dataMapperWorkspacesId" => + URI.encode(data_mapper_workspaces_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5821,19 +5828,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Empty{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}] + ) end @doc """ - 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 errors in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. + Creates a new DICOM store within the parent dataset. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this DICOM store belongs to. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5846,33 +5854,32 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ExportDicomDataRequest.t`) - + * `:dicomStoreId` (*type:* `String.t`) - Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length. + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DicomStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_export( + @spec healthcare_projects_locations_datasets_dicom_stores_create( Tesla.Env.client(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_export( + def healthcare_projects_locations_datasets_dicom_stores_create( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, optional_params \\ [], opts \\ [] ) do @@ -5888,6 +5895,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, + :dicomStoreId => :query, :body => :body } @@ -5895,12 +5903,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5908,19 +5915,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}]) end @doc """ - Gets the specified DICOM store. + 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. 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. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the DICOM store to get. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Required. Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -5933,14 +5940,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyDicomStoreRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_get( + @spec healthcare_projects_locations_datasets_dicom_stores_deidentify( Tesla.Env.client(), String.t(), String.t(), @@ -5949,11 +5957,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStore.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_get( + def healthcare_projects_locations_datasets_dicom_stores_deidentify( connection, projects_id, locations_id, @@ -5973,19 +5981,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -5993,19 +6002,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + Deletes the specified DICOM store and removes all images that are contained within it. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the DICOM store to delete. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6018,15 +6027,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Empty{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( + @spec healthcare_projects_locations_datasets_dicom_stores_delete( Tesla.Env.client(), String.t(), String.t(), @@ -6035,11 +6043,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( + def healthcare_projects_locations_datasets_dicom_stores_delete( connection, projects_id, locations_id, @@ -6059,20 +6067,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :"options.requestedPolicyVersion" => :query + :upload_protocol => :query } request = Request.new() - |> Request.method(:get) + |> Request.method(:delete) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getIamPolicy", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6080,16 +6087,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Empty{}]) end @doc """ - Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. + 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 errors in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -6105,7 +6112,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ImportDicomDataRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ExportDicomDataRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -6113,7 +6120,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_import( + @spec healthcare_projects_locations_datasets_dicom_stores_export( Tesla.Env.client(), String.t(), String.t(), @@ -6126,7 +6133,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_import( + def healthcare_projects_locations_datasets_dicom_stores_export( connection, projects_id, locations_id, @@ -6154,7 +6161,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -6171,14 +6178,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Lists the DICOM stores in the given dataset. + Gets the specified DICOM store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the DICOM store to get. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6191,33 +6199,32 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`. - * `:pageSize` (*type:* `integer()`) - Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. - * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.ListDicomStoresResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_list( + @spec healthcare_projects_locations_datasets_dicom_stores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.ListDicomStoresResponse.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_list( + def healthcare_projects_locations_datasets_dicom_stores_get( connection, projects_id, locations_id, datasets_id, + dicom_stores_id, optional_params \\ [], opts \\ [] ) do @@ -6232,21 +6239,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :filter => :query, - :pageSize => :query, - :pageToken => :query + :upload_protocol => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6254,21 +6259,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode( - opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.ListDicomStoresResponse{}] - ) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}]) end @doc """ - Updates the specified DICOM store. + Gets metrics associated with the DICOM store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `dicomStore.name`. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the DICOM store to get metrics for. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6281,16 +6284,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DicomStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_patch( + @spec healthcare_projects_locations_datasets_dicom_stores_get_dicom_store_metrics( Tesla.Env.client(), String.t(), String.t(), @@ -6299,11 +6300,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStore.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_patch( + def healthcare_projects_locations_datasets_dicom_stores_get_dicom_store_metrics( connection, projects_id, locations_id, @@ -6323,21 +6324,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :updateMask => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:patch) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getDICOMStoreMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6345,19 +6344,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics{}]) end @doc """ - SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6370,14 +6369,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_search_for_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -6386,11 +6386,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_search_for_instances( + def healthcare_projects_locations_datasets_dicom_stores_get_iam_policy( connection, projects_id, locations_id, @@ -6410,14 +6410,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :"options.requestedPolicyVersion" => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -6430,19 +6431,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) end @doc """ - SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6455,14 +6456,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ImportDicomDataRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_search_for_series( + @spec healthcare_projects_locations_datasets_dicom_stores_import( Tesla.Env.client(), String.t(), String.t(), @@ -6471,11 +6473,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_search_for_series( + def healthcare_projects_locations_datasets_dicom_stores_import( connection, projects_id, locations_id, @@ -6495,14 +6497,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -6515,19 +6518,18 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + Lists the DICOM stores in the given dataset. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6540,32 +6542,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`. + * `:pageSize` (*type:* `integer()`) - Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. + * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.ListDicomStoresResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_search_for_studies( + @spec healthcare_projects_locations_datasets_dicom_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.ListDicomStoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_search_for_studies( + def healthcare_projects_locations_datasets_dicom_stores_list( connection, projects_id, locations_id, datasets_id, - dicom_stores_id, optional_params \\ [], opts \\ [] ) do @@ -6580,19 +6583,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :filter => :query, + :pageSize => :query, + :pageToken => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6600,19 +6605,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.ListDicomStoresResponse{}] + ) end @doc """ - Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + Updates the specified DICOM store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `dicomStore.name`. Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `dicomStore.name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6625,15 +6632,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetIamPolicyRequest.t`) - + * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DicomStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( + @spec healthcare_projects_locations_datasets_dicom_stores_patch( Tesla.Env.client(), String.t(), String.t(), @@ -6642,11 +6650,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.DicomStore.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( + def healthcare_projects_locations_datasets_dicom_stores_patch( connection, projects_id, locations_id, @@ -6667,19 +6675,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, + :updateMask => :query, :body => :body } request = Request.new() - |> Request.method(:post) + |> Request.method(:patch) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6687,16 +6696,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.DicomStore{}]) end @doc """ - 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). + SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -6712,7 +6721,6 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -6720,7 +6728,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_store_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_search_for_instances( Tesla.Env.client(), String.t(), String.t(), @@ -6733,7 +6741,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_store_instances( + def healthcare_projects_locations_datasets_dicom_stores_search_for_instances( connection, projects_id, locations_id, @@ -6753,15 +6761,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -6778,15 +6785,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - 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. + SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6799,15 +6806,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( + @spec healthcare_projects_locations_datasets_dicom_stores_search_for_series( Tesla.Env.client(), String.t(), String.t(), @@ -6816,11 +6822,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( + def healthcare_projects_locations_datasets_dicom_stores_search_for_series( connection, projects_id, locations_id, @@ -6840,15 +6846,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -6861,22 +6866,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode( - opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}] - ) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). + SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the DeleteStudy request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6893,30 +6895,28 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_search_for_studies( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_delete( + def healthcare_projects_locations_datasets_dicom_stores_search_for_studies( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -6936,15 +6936,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do request = Request.new() - |> Request.method(:delete) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -6952,20 +6951,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). + SetBlobStorageSettings sets the blob storage settings of the specified resources. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -6978,34 +6976,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( + @spec healthcare_projects_locations_datasets_dicom_stores_set_blob_storage_settings( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( + def healthcare_projects_locations_datasets_dicom_stores_set_blob_storage_settings( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -7020,20 +7017,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setBlobStorageSettings", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7041,20 +7038,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). + Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7067,34 +7063,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( + @spec healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( + def healthcare_projects_locations_datasets_dicom_stores_set_iam_policy( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -7109,20 +7104,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7130,20 +7125,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) end @doc """ - SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7156,6 +7150,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -7163,13 +7158,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_store_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -7177,13 +7171,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( + def healthcare_projects_locations_datasets_dicom_stores_store_instances( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -7198,20 +7191,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7223,16 +7216,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + 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. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7245,34 +7237,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( + @spec healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( + def healthcare_projects_locations_datasets_dicom_stores_test_iam_permissions( connection, projects_id, locations_id, datasets_id, dicom_stores_id, - studies_id, optional_params \\ [], opts \\ [] ) do @@ -7287,20 +7278,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7308,20 +7299,22 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}] + ) end @doc """ - 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). + GetStudyMetrics returns metrics for a study. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. + * `projects_id` (*type:* `String.t`) - Part of `study`. Required. The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`. + * `locations_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `study`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7334,15 +7327,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.StudyMetrics{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics( Tesla.Env.client(), String.t(), String.t(), @@ -7352,11 +7344,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.StudyMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( + def healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_get_study_metrics( connection, projects_id, locations_id, @@ -7377,21 +7369,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:getStudyMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7399,21 +7390,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.StudyMetrics{}]) end @doc """ - DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). + SetBlobStorageSettings sets the blob storage settings of the specified resources. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7426,6 +7416,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -7433,14 +7424,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_set_blob_storage_settings( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -7448,14 +7438,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( + def healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_set_blob_storage_settings( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, optional_params \\ [], opts \\ [] ) do @@ -7470,21 +7459,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:delete) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:setBlobStorageSettings", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7496,17 +7485,17 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). + GetSeriesMetrics returns metrics for a series. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `projects_id` (*type:* `String.t`) - Part of `series`. Required. The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`. + * `locations_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. + * `series_id` (*type:* `String.t`) - Part of `series`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7523,10 +7512,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( + @spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics( Tesla.Env.client(), String.t(), String.t(), @@ -7537,11 +7526,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( + def healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_get_series_metrics( connection, projects_id, locations_id, @@ -7570,7 +7559,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}:getSeriesMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -7585,21 +7574,22 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics{}]) end @doc """ - RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). + GetStorageInfo returns the storage info of the specified resource. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`) + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `series_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `instances_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7616,10 +7606,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.StorageInfo{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( + @spec healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_instances_get_storage_info( Tesla.Env.client(), String.t(), String.t(), @@ -7627,14 +7617,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.StorageInfo.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( + def healthcare_projects_locations_datasets_dicom_stores_dicom_web_studies_series_instances_get_storage_info( connection, projects_id, locations_id, @@ -7642,6 +7633,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do dicom_stores_id, studies_id, series_id, + instances_id, optional_params \\ [], opts \\ [] ) do @@ -7663,14 +7655,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}:getStorageInfo", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7678,21 +7671,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.StorageInfo{}]) end @doc """ - SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). + DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the DeleteStudy request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7709,32 +7701,30 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( + def healthcare_projects_locations_datasets_dicom_stores_studies_delete( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, optional_params \\ [], opts \\ [] ) do @@ -7754,16 +7744,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do request = Request.new() - |> Request.method(:get) + |> Request.method(:delete) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) + "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7771,22 +7760,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). + RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7803,34 +7790,30 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Empty{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Empty.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( + def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_metadata( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -7850,17 +7833,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do request = Request.new() - |> Request.method(:delete) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7868,22 +7849,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Empty{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance). + RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -7903,15 +7882,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -7919,15 +7896,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( + def healthcare_projects_locations_datasets_dicom_stores_studies_retrieve_study( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -7949,15 +7924,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -7969,18 +7942,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). + SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8000,15 +7971,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -8016,15 +7985,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( + def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_instances( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -8046,15 +8013,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8066,18 +8031,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). + SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8097,15 +8060,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -8113,15 +8074,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + def healthcare_projects_locations_datasets_dicom_stores_studies_search_for_series( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, optional_params \\ [], opts \\ [] ) do @@ -8143,15 +8102,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8163,19 +8120,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). + 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). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. - * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8188,6 +8142,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -8195,16 +8150,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), - String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: @@ -8212,16 +8164,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + def healthcare_projects_locations_datasets_dicom_stores_studies_store_instances( connection, projects_id, locations_id, datasets_id, dicom_stores_id, studies_id, - series_id, - instances_id, - frames_id, optional_params \\ [], opts \\ [] ) do @@ -8236,23 +8185,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), - "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), - "framesId" => URI.encode(frames_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "studiesId" => URI.encode(studies_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8264,19 +8211,17 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). + DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. 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}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`. * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. - * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8293,10 +8238,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( Tesla.Env.client(), String.t(), String.t(), @@ -8304,16 +8249,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do String.t(), String.t(), String.t(), - String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_delete( connection, projects_id, locations_id, @@ -8321,8 +8264,6 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do dicom_stores_id, studies_id, series_id, - instances_id, - frames_id, optional_params \\ [], opts \\ [] ) do @@ -8342,18 +8283,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do request = Request.new() - |> Request.method(:get) + |> Request.method(:delete) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), - "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), - "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), - "framesId" => URI.encode(frames_id, &URI.char_unreserved?/1) + "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8361,19 +8300,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation. + RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the FHIR store to configure, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8386,33 +8327,36 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ConfigureSearchRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_configure_search( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_configure_search( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_metadata( connection, projects_id, locations_id, datasets_id, - fhir_stores_id, + dicom_stores_id, + studies_id, + series_id, optional_params \\ [], opts \\ [] ) do @@ -8427,20 +8371,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:configureSearch", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8448,18 +8393,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - Creates a new FHIR store within the parent dataset. + RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this FHIR store belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8472,32 +8420,36 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:fhirStoreId` (*type:* `String.t`) - The ID of the FHIR store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.FhirStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_create( + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), + String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.FhirStore.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_create( + def healthcare_projects_locations_datasets_dicom_stores_studies_series_retrieve_series( connection, projects_id, locations_id, datasets_id, + dicom_stores_id, + studies_id, + series_id, optional_params \\ [], opts \\ [] ) do @@ -8512,20 +8464,1673 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :fhirStoreId => :query, - :body => :body + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_search_for_instances( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Empty{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Empty.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_delete( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:delete) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Empty{}]) + end + + @doc """ + RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_instance( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_metadata( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_retrieve_rendered( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4){: .external}. For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path for the `RetrieveBulkdata` DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/bukdata/{bulkdata_uri}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `bulkdata_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `bulkdata_id1` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_bulkdata_retrieve_bulkdata( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_bulkdata_retrieve_bulkdata( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + bulkdata_id, + bulkdata_id1, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), + "bulkdataId" => URI.encode(bulkdata_id, &URI.char_unreserved?/1), + "bulkdataId1" => URI.encode(bulkdata_id1, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_frames( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + frames_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), + "framesId" => URI.encode(frames_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. 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}`. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `dicom_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `studies_id` (*type:* `String.t`) - Part of `dicomWebPath`. Required. The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/frames/{frame_list}/rendered`. + * `series_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `instances_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `frames_id` (*type:* `String.t`) - Part of `dicomWebPath`. See documentation of `studiesId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_dicom_stores_studies_series_instances_frames_retrieve_rendered( + connection, + projects_id, + locations_id, + datasets_id, + dicom_stores_id, + studies_id, + series_id, + instances_id, + frames_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "dicomStoresId" => URI.encode(dicom_stores_id, &URI.char_unreserved?/1), + "studiesId" => URI.encode(studies_id, &URI.char_unreserved?/1), + "seriesId" => URI.encode(series_id, &URI.char_unreserved?/1), + "instancesId" => URI.encode(instances_id, &URI.char_unreserved?/1), + "framesId" => URI.encode(frames_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) + end + + @doc """ + Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the `consent_config.enforced_admin_consents` field of the FhirStore unless `validate_only=true` in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the `consent_config.enforced_admin_consents` field will be unchanged. To enforce a consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_apply_admin_consents( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_apply_admin_consents( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyAdminConsents", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + end + + @doc """ + Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). To enforce consent check for data access, `consent_config.access_enforced` must be set to true for the FhirStore. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_apply_consents( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_apply_consents( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:applyConsents", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + end + + @doc """ + Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to configure, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ConfigureSearchRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_configure_search( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_configure_search( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:configureSearch", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + end + + @doc """ + Creates a new FHIR store within the parent dataset. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this FHIR store belongs to. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:fhirStoreId` (*type:* `String.t`) - Required. The ID of the FHIR store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.FhirStore.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_create( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.FhirStore.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_create( + connection, + projects_id, + locations_id, + datasets_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :fhirStoreId => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}]) + end + + @doc """ + 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 DeidentifyFhirStoreSummary. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyFhirStoreRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_deidentify( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_deidentify( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + end + + @doc """ + Deletes the specified FHIR store and removes all resources within it. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the FHIR store to delete. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Empty{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_delete( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Empty.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_delete( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:delete) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Empty{}]) + end + + @doc """ + Explains all the permitted/denied actor, purpose and environment for a given resource. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to enforce, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:resourceId` (*type:* `String.t`) - Required. The ID (`{resourceType}/{id}`) of the resource to explain data access on. + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_explain_data_access( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_explain_data_access( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :resourceId => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:explainDataAccess", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse{}] + ) + end + + @doc """ + Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ExportResourcesRequest.t`) - + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_export( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_export( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query, + :body => :body + } + + request = + Request.new() + |> Request.method(:post) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + end + + @doc """ + Gets the configuration of the specified FHIR store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the FHIR store to get. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_get( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.FhirStore.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_get( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}]) + end + + @doc """ + Gets metrics associated with the FHIR store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the FHIR store to get metrics for. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_fhir_stores_get_fhir_store_metrics( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_fhir_stores_get_fhir_store_metrics( + connection, + projects_id, + locations_id, + datasets_id, + fhir_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getFHIRStoreMetrics", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8533,19 +10138,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics{}]) end @doc """ - 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 DeidentifyFhirStoreSummary. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). + Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `sourceStore`. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `sourceStore`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8558,15 +10163,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyFhirStoreRequest.t`) - + * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_deidentify( + @spec healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -8575,11 +10180,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_deidentify( + def healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( connection, projects_id, locations_id, @@ -8600,14 +10205,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :body => :body + :"options.requestedPolicyVersion" => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -8620,16 +10225,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) end @doc """ - Deletes the specified FHIR store and removes all resources within it. + Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data are specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the FHIR store to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -8645,14 +10250,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ImportResourcesRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Empty{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_delete( + @spec healthcare_projects_locations_datasets_fhir_stores_import( Tesla.Env.client(), String.t(), String.t(), @@ -8661,11 +10267,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Empty.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_delete( + def healthcare_projects_locations_datasets_fhir_stores_import( connection, projects_id, locations_id, @@ -8685,19 +10291,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :body => :body } request = Request.new() - |> Request.method(:delete) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8705,19 +10312,18 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Empty{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + Lists the FHIR stores in the given dataset. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8730,33 +10336,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ExportResourcesRequest.t`) - + * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`. + * `:pageSize` (*type:* `integer()`) - Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. + * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.ListFhirStoresResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_export( + @spec healthcare_projects_locations_datasets_fhir_stores_list( Tesla.Env.client(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.ListFhirStoresResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_export( + def healthcare_projects_locations_datasets_fhir_stores_list( connection, projects_id, locations_id, datasets_id, - fhir_stores_id, optional_params \\ [], opts \\ [] ) do @@ -8772,19 +10378,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :body => :body + :filter => :query, + :pageSize => :query, + :pageToken => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -8792,19 +10399,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode( + opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.ListFhirStoresResponse{}] + ) end @doc """ - Gets the configuration of the specified FHIR store. + Updates the configuration of the specified FHIR store. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the FHIR store to get. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `fhirStore.name`. Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8817,6 +10426,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.FhirStore.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -8824,7 +10435,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_get( + @spec healthcare_projects_locations_datasets_fhir_stores_patch( Tesla.Env.client(), String.t(), String.t(), @@ -8837,7 +10448,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_get( + def healthcare_projects_locations_datasets_fhir_stores_patch( connection, projects_id, locations_id, @@ -8857,12 +10468,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :updateMask => :query, + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:patch) |> Request.url( "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", %{ @@ -8881,15 +10494,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8902,15 +10515,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:"options.requestedPolicyVersion"` (*type:* `integer()`) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( + @spec healthcare_projects_locations_datasets_fhir_stores_rollback( Tesla.Env.client(), String.t(), String.t(), @@ -8919,11 +10532,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_get_iam_policy( + def healthcare_projects_locations_datasets_fhir_stores_rollback( connection, projects_id, locations_id, @@ -8944,14 +10557,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :"options.requestedPolicyVersion" => :query + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getIamPolicy", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:rollback", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -8964,19 +10577,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) end @doc """ - Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data are specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -8989,15 +10602,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ImportResourcesRequest.t`) - + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetIamPolicyRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Operation{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_import( + @spec healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), @@ -9006,11 +10619,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Operation.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_import( + def healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( connection, projects_id, locations_id, @@ -9038,7 +10651,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do Request.new() |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -9051,18 +10664,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Operation{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) end @doc """ - Lists the FHIR stores in the given dataset. + 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. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9075,33 +10689,33 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:filter` (*type:* `String.t`) - Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`. - * `:pageSize` (*type:* `integer()`) - Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. - * `:pageToken` (*type:* `String.t`) - The next_page_token value returned from the previous List request, if any. + * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.ListFhirStoresResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_list( + @spec healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.ListFhirStoresResponse.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_list( + def healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( connection, projects_id, locations_id, datasets_id, + fhir_stores_id, optional_params \\ [], opts \\ [] ) do @@ -9117,20 +10731,19 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :filter => :query, - :pageSize => :query, - :pageToken => :query + :body => :body } request = Request.new() - |> Request.method(:get) + |> Request.method(:post) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), - "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1) + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9139,20 +10752,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) |> Response.decode( - opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.ListFhirStoresResponse{}] + opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}] ) end @doc """ - Updates the configuration of the specified FHIR store. + Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `fhirStore.name`. Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `locations_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `fhirStore.name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name for the FHIR store containing the concept map(s) to use for the translation. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9165,16 +10778,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.FhirStore.t`) - + * `:code` (*type:* `String.t`) - Required. The code to translate. + * `:conceptMapVersion` (*type:* `String.t`) - The version of the concept map to use. If unset, the most current version is used. + * `:source` (*type:* `String.t`) - The source value set of the concept map to be used. If unset, target is used to search for concept maps. + * `:system` (*type:* `String.t`) - Required. The system for the code to be translated. + * `:target` (*type:* `String.t`) - The target value set of the concept map to be used. If unset, source is used to search for concept maps. + * `:url` (*type:* `String.t`) - The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_patch( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_search_translate( Tesla.Env.client(), String.t(), String.t(), @@ -9183,11 +10800,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.FhirStore.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_patch( + def healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_search_translate( connection, projects_id, locations_id, @@ -9208,20 +10825,24 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :updateMask => :query, - :body => :body + :code => :query, + :conceptMapVersion => :query, + :source => :query, + :system => :query, + :target => :query, + :url => :query } request = Request.new() - |> Request.method(:patch) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/$translate", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &(URI.char_unreserved?(&1) || &1 == ?/)) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9229,19 +10850,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.FhirStore{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The URL for the concept map to use for the translation. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `concept_map_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9254,33 +10876,37 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SetIamPolicyRequest.t`) - + * `:code` (*type:* `String.t`) - Required. The code to translate. + * `:conceptMapVersion` (*type:* `String.t`) - The version of the concept map to use. If unset, the most current version is used. + * `:system` (*type:* `String.t`) - Required. The system for the code to be translated. * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Policy{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_translate( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.Policy.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_set_iam_policy( + def healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_translate( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + concept_map_id, optional_params \\ [], opts \\ [] ) do @@ -9296,19 +10922,22 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :body => :body + :code => :query, + :conceptMapVersion => :query, + :system => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/{ConceptMapId}/$translate", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "ConceptMapId" => URI.encode(concept_map_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9316,19 +10945,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Policy{}]) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - 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. + Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * `locations_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `resource`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the consent resource to find enforcement status, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{consent_id}` + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `consent_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9341,33 +10971,34 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsRequest.t`) - * `opts` (*type:* `keyword()`) - Call options ## Returns - * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}}` on success + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__consent_enforcement_status( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: - {:ok, GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse.t()} + {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_test_iam_permissions( + def healthcare_projects_locations_datasets_fhir_stores_fhir__consent_enforcement_status( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + consent_id, optional_params \\ [], opts \\ [] ) do @@ -9382,20 +11013,20 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :body => :body + :upload_protocol => :query } request = Request.new() - |> Request.method(:post) + |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Consent/{ConsentId}/$consent-enforcement-status", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "ConsentId" => URI.encode(consent_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9403,18 +11034,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do connection |> Connection.execute(request) - |> Response.decode( - opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.TestIamPermissionsResponse{}] - ) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}]) end @doc """ - Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name for the FHIR store containing the concept map(s) to use for the translation. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store to retrieve resources from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -9430,12 +11059,6 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:code` (*type:* `String.t`) - The code to translate. - * `:conceptMapVersion` (*type:* `String.t`) - The version of the concept map to use. If unset, the most current version is used. - * `:source` (*type:* `String.t`) - The source value set of the concept map to be used. If unset, target is used to search for concept maps. - * `:system` (*type:* `String.t`) - The system for the code to be translated. - * `:target` (*type:* `String.t`) - The target value set of the concept map to be used. If unset, source is used to search for concept maps. - * `:url` (*type:* `String.t`) - The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps. * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -9443,7 +11066,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_search_translate( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__observation_lastn( Tesla.Env.client(), String.t(), String.t(), @@ -9456,7 +11079,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_search_translate( + def healthcare_projects_locations_datasets_fhir_stores_fhir__observation_lastn( connection, projects_id, locations_id, @@ -9476,20 +11099,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query, - :code => :query, - :conceptMapVersion => :query, - :source => :query, - :system => :query, - :target => :query, - :url => :query + :upload_protocol => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/$translate", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Observation/$lastn", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), @@ -9506,16 +11123,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The URL for the concept map to use for the translation. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the patient to find enforcement statuses, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}` * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `concept_map_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `patient_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9528,9 +11145,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:code` (*type:* `String.t`) - The code to translate. - * `:conceptMapVersion` (*type:* `String.t`) - The version of the concept map to use. If unset, the most current version is used. - * `:system` (*type:* `String.t`) - The system for the code to be translated. + * `:_count` (*type:* `integer()`) - Optional. The maximum number of results on a page. If not specified, 100 is used. May not be larger than 1000. + * `:_page_token` (*type:* `String.t`) - Optional. Used to retrieve the first, previous, next, or last page of consent enforcement statuses when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -9538,7 +11154,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_translate( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__patient_consent_enforcement_status( Tesla.Env.client(), String.t(), String.t(), @@ -9552,13 +11168,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__concept_map_translate( + def healthcare_projects_locations_datasets_fhir_stores_fhir__patient_consent_enforcement_status( connection, projects_id, locations_id, datasets_id, fhir_stores_id, - concept_map_id, + patient_id, optional_params \\ [], opts \\ [] ) do @@ -9574,22 +11190,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :quotaUser => :query, :uploadType => :query, :upload_protocol => :query, - :code => :query, - :conceptMapVersion => :query, - :system => :query + :_count => :query, + :_page_token => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/{ConceptMapId}/$translate", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$consent-enforcement-status", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), - "ConceptMapId" => URI.encode(concept_map_id, &URI.char_unreserved?/1) + "PatientId" => URI.encode(patient_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9601,15 +11216,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store to retrieve resources from. - * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. Name of the `Patient` resource for which the information is required. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `patient_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9622,6 +11238,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `:_count` (*type:* `integer()`) - Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. + * `:_page_token` (*type:* `String.t`) - Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. + * `:_since` (*type:* `String.t`) - If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. + * `:_type` (*type:* `String.t`) - String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple `_type` parameters isn't supported. For example, the result of `_type=Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter` instead. + * `:end` (*type:* `String.t`) - The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope. + * `:start` (*type:* `String.t`) - The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope. * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -9629,12 +11251,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__observation_lastn( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), + String.t(), keyword(), keyword() ) :: @@ -9642,12 +11265,13 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__observation_lastn( + def healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( connection, projects_id, locations_id, datasets_id, fhir_stores_id, + patient_id, optional_params \\ [], opts \\ [] ) do @@ -9662,19 +11286,26 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :prettyPrint => :query, :quotaUser => :query, :uploadType => :query, - :upload_protocol => :query + :upload_protocol => :query, + :_count => :query, + :_page_token => :query, + :_since => :query, + :_type => :query, + :end => :query, + :start => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Observation/$lastn", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), + "PatientId" => URI.encode(patient_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9686,16 +11317,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). + Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead. ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. Name of the `Patient` resource for which the information is required. - * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. - * `patient_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store that holds the target resource. + * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. + * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9709,11 +11339,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). * `:_count` (*type:* `integer()`) - Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. - * `:_page_token` (*type:* `String.t`) - Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made. - * `:_since` (*type:* `String.t`) - If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. - * `:_type` (*type:* `String.t`) - String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. - * `:end` (*type:* `String.t`) - The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope. - * `:start` (*type:* `String.t`) - The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope. + * `:_page_token` (*type:* `String.t`) - Used to retrieve the next page of results when using pagination. Set `_page_token` to the value of _page_token set in next page links' url. Next page are returned in the response bundle's links field, where `link.relation` is "next". Omit `_page_token` if no previous request has been made. + * `:_summary` (*type:* `String.t`) - Used to simplify the representation of the returned resources. `_summary=text` returns only the `text`, `id`, and `meta` top-level fields. `_summary=data` removes the `text` field and returns all other fields. `_summary=false` returns all parts of the resource(s). Either not providing this parameter or providing an empty value to this parameter also returns all parts of the resource(s). + * `:_type` (*type:* `String.t`) - String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. If not provided or an empty value is provided, no filter on the returned resource type(s) is applied. + * `:target` (*type:* `String.t`) - Required. The target whose incoming references are requested. This param is required and must not be empty. It uses the format "ResourceType/ResourceID", for example, target=ResourceType/ResourceID. * `opts` (*type:* `keyword()`) - Call options ## Returns @@ -9721,13 +11350,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}` on success * `{:error, info}` on failure """ - @spec healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( + @spec healthcare_projects_locations_datasets_fhir_stores_fhir__resource_incoming_references( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), - String.t(), keyword(), keyword() ) :: @@ -9735,13 +11363,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()} - def healthcare_projects_locations_datasets_fhir_stores_fhir__patient_everything( + def healthcare_projects_locations_datasets_fhir_stores_fhir__resource_incoming_references( connection, projects_id, locations_id, datasets_id, fhir_stores_id, - patient_id, optional_params \\ [], opts \\ [] ) do @@ -9759,23 +11386,21 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do :upload_protocol => :query, :_count => :query, :_page_token => :query, - :_since => :query, + :_summary => :query, :_type => :query, - :end => :query, - :start => :query + :target => :query } request = Request.new() |> Request.method(:get) |> Request.url( - "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$references", %{ "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), - "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1), - "PatientId" => URI.encode(patient_id, &URI.char_unreserved?/1) + "fhirStoresId" => URI.encode(fhir_stores_id, &URI.char_unreserved?/1) } ) |> Request.add_optional_params(optional_params_config, optional_params) @@ -9792,7 +11417,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to purge. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to purge. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -9885,11 +11510,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store that holds the profiles being used for validation. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store that holds the profiles being used for validation. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -9902,7 +11527,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:profile` (*type:* `String.t`) - The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. + * `:profile` (*type:* `String.t`) - Required. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource against the US Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient`. A StructureDefinition with this canonical URL must exist in the FHIR store. * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.HttpBody.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -9978,7 +11603,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. Name of the FHIR store to retrieve the capabilities for. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. Name of the FHIR store to retrieve the capabilities for. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10063,11 +11688,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store this resource belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -10152,11 +11777,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store this resource belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -10243,11 +11868,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store this resource belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -10334,11 +11959,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the FHIR store this resource belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the FHIR store this resource belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `fhir_id` (*type:* `String.t`) - Part of `type`. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * `fhir_id` (*type:* `String.t`) - Part of `type`. Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -10425,7 +12050,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10513,12 +12138,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). + Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store in which this bundle will be executed. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store in which this bundle will be executed. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -10605,7 +12230,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10706,7 +12331,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to update. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to update. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10801,7 +12426,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -10889,12 +12514,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store to retrieve resources from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store to retrieve resources from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -10976,16 +12601,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the FHIR store to retrieve resources from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the FHIR store to retrieve resources from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. - * `resource_type` (*type:* `String.t`) - The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * `resource_type` (*type:* `String.t`) - Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * `optional_params` (*type:* `keyword()`) - Optional parameters * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. * `:access_token` (*type:* `String.t`) - OAuth access token. @@ -11072,7 +12697,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource to update. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource to update. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -11167,7 +12792,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the resource version to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the resource version to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `fhir_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -11264,7 +12889,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this HL7v2 store belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the dataset this HL7v2 store belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -11279,7 +12904,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:hl7V2StoreId` (*type:* `String.t`) - The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. + * `:hl7V2StoreId` (*type:* `String.t`) - Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\\p{L}\\p{N}_\\-\\.]{1,256}`. * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Hl7V2Store.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -11349,7 +12974,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 store to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 store to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -11434,7 +13059,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -11521,7 +13146,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 store to get. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 store to get. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -11600,6 +13225,91 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Hl7V2Store{}]) end + @doc """ + Gets metrics associated with the HL7v2 store. + + ## Parameters + + * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. + * `optional_params` (*type:* `keyword()`) - Optional parameters + * `:"$.xgafv"` (*type:* `String.t`) - V1 error format. + * `:access_token` (*type:* `String.t`) - OAuth access token. + * `:alt` (*type:* `String.t`) - Data format for response. + * `:callback` (*type:* `String.t`) - JSONP + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). + * `opts` (*type:* `keyword()`) - Call options + + ## Returns + + * `{:ok, %GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics{}}` on success + * `{:error, info}` on failure + """ + @spec healthcare_projects_locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics( + Tesla.Env.client(), + String.t(), + String.t(), + String.t(), + String.t(), + keyword(), + keyword() + ) :: + {:ok, GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics.t()} + | {:ok, Tesla.Env.t()} + | {:ok, list()} + | {:error, any()} + def healthcare_projects_locations_datasets_hl7_v2_stores_get_hl7v2_store_metrics( + connection, + projects_id, + locations_id, + datasets_id, + hl7_v2_stores_id, + optional_params \\ [], + opts \\ [] + ) do + optional_params_config = %{ + :"$.xgafv" => :query, + :access_token => :query, + :alt => :query, + :callback => :query, + :fields => :query, + :key => :query, + :oauth_token => :query, + :prettyPrint => :query, + :quotaUser => :query, + :uploadType => :query, + :upload_protocol => :query + } + + request = + Request.new() + |> Request.method(:get) + |> Request.url( + "/v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", + %{ + "projectsId" => URI.encode(projects_id, &URI.char_unreserved?/1), + "locationsId" => URI.encode(locations_id, &URI.char_unreserved?/1), + "datasetsId" => URI.encode(datasets_id, &URI.char_unreserved?/1), + "hl7V2StoresId" => URI.encode(hl7_v2_stores_id, &URI.char_unreserved?/1) + } + ) + |> Request.add_optional_params(optional_params_config, optional_params) + |> Request.library_version(@library_version) + + connection + |> Connection.execute(request) + |> Response.decode(opts ++ [struct: %GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics{}]) + end + @doc """ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -11693,7 +13403,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}` * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -11780,7 +13490,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the dataset. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the dataset. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `optional_params` (*type:* `keyword()`) - Optional parameters @@ -11869,7 +13579,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `hl7V2Store.name`. See documentation of `projectsId`. @@ -11885,7 +13595,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Hl7V2Store.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -12134,7 +13844,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -12225,7 +13935,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the dataset this message belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the HL7v2 store this message belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -12312,7 +14022,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 message to delete. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 message to delete. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -12401,7 +14111,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `name`. The resource name of the HL7v2 message to retrieve. + * `projects_id` (*type:* `String.t`) - Part of `name`. Required. The resource name of the HL7v2 message to retrieve. * `locations_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `name`. See documentation of `projectsId`. @@ -12492,7 +14202,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. The name of the HL7v2 store this message belongs to. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. The name of the HL7v2 store this message belongs to. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -12581,7 +14291,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `parent`. Name of the HL7v2 store to retrieve messages from. + * `projects_id` (*type:* `String.t`) - Part of `parent`. Required. Name of the HL7v2 store to retrieve messages from. * `locations_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `parent`. See documentation of `projectsId`. @@ -12678,7 +14388,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do ## Parameters * `connection` (*type:* `GoogleApi.HealthCare.V1beta1.Connection.t`) - Connection to server - * `projects_id` (*type:* `String.t`) - Part of `message.name`. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. + * `projects_id` (*type:* `String.t`) - Part of `message.name`. Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. * `locations_id` (*type:* `String.t`) - Part of `message.name`. See documentation of `projectsId`. * `datasets_id` (*type:* `String.t`) - Part of `message.name`. See documentation of `projectsId`. * `hl7_v2_stores_id` (*type:* `String.t`) - Part of `message.name`. See documentation of `projectsId`. @@ -12695,7 +14405,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). - * `:updateMask` (*type:* `String.t`) - The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * `:updateMask` (*type:* `String.t`) - Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * `:body` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Message.t`) - * `opts` (*type:* `keyword()`) - Call options @@ -12938,7 +14648,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Api.Projects do end @doc """ - Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. ## Parameters diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/connection.ex b/clients/health_care/lib/google_api/health_care/v1beta1/connection.ex index cea2cefa44..4f859cee4a 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/connection.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/connection.ex @@ -24,6 +24,9 @@ defmodule GoogleApi.HealthCare.V1beta1.Connection do use GoogleApi.Gax.Connection, scopes: [ + # Read, write and manage healthcare data + "https://www.googleapis.com/auth/cloud-healthcare", + # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. "https://www.googleapis.com/auth/cloud-platform" ], diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/metadata.ex b/clients/health_care/lib/google_api/health_care/v1beta1/metadata.ex index 2ea419727a..4969c7f0f7 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/metadata.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/metadata.ex @@ -20,7 +20,7 @@ defmodule GoogleApi.HealthCare.V1beta1 do API client metadata for GoogleApi.HealthCare.V1beta1. """ - @discovery_revision "20221027" + @discovery_revision "20240228" def discovery_revision(), do: @discovery_revision end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/access_determination_log_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/access_determination_log_config.ex new file mode 100644 index 0000000000..0ddb9e874f --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/access_determination_log_config.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig do + @moduledoc """ + Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. + + ## Attributes + + * `logLevel` (*type:* `String.t`, *default:* `nil`) - Optional. Controls the amount of detail to include as part of the audit logs. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :logLevel => String.t() | nil + } + + field(:logLevel) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/admin_consents.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/admin_consents.ex new file mode 100644 index 0000000000..e88ee41fb7 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/admin_consents.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.AdminConsents do + @moduledoc """ + List of admin Consent resources to be applied. + + ## Attributes + + * `names` (*type:* `list(String.t)`, *default:* `nil`) - The versioned names of the admin Consent resource(s), in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :names => list(String.t()) | nil + } + + field(:names, type: :list) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.AdminConsents do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.AdminConsents.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.AdminConsents do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_request.ex index 297bb4422e..b9fd371e0d 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_request.ex @@ -21,6 +21,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.AnalyzeEntitiesRequest do ## Attributes + * `alternativeOutputFormat` (*type:* `String.t`, *default:* `nil`) - Optional. Alternative output format to be generated based on the results of analysis. * `documentContent` (*type:* `String.t`, *default:* `nil`) - document_content is a document to be annotated. * `licensedVocabularies` (*type:* `list(String.t)`, *default:* `nil`) - A list of licensed vocabularies to use in the request, in addition to the default unlicensed vocabularies. """ @@ -28,10 +29,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.AnalyzeEntitiesRequest do use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ + :alternativeOutputFormat => String.t() | nil, :documentContent => String.t() | nil, :licensedVocabularies => list(String.t()) | nil } + field(:alternativeOutputFormat) field(:documentContent) field(:licensedVocabularies, type: :list) end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_response.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_response.ex index b87e58c312..56e1c43df8 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_response.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/analyze_entities_response.ex @@ -22,7 +22,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.AnalyzeEntitiesResponse do ## Attributes * `entities` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.Entity.t)`, *default:* `nil`) - The union of all the candidate entities that the entity_mentions in this response could link to. These are UMLS concepts or normalized mention content. - * `entityMentions` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.EntityMention.t)`, *default:* `nil`) - entity_mentions contains all the annotated medical entities that were mentioned in the provided document. + * `entityMentions` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.EntityMention.t)`, *default:* `nil`) - The `entity_mentions` field contains all the annotated medical entities that were mentioned in the provided document. + * `fhirBundle` (*type:* `String.t`, *default:* `nil`) - The FHIR bundle ([`R4`](http://hl7.org/fhir/R4/bundle.html)) that includes all the entities, the entity mentions, and the relationships in JSON format. * `relationships` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.EntityMentionRelationship.t)`, *default:* `nil`) - relationships contains all the binary relationships that were identified between entity mentions within the provided document. """ @@ -31,12 +32,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.AnalyzeEntitiesResponse do @type t :: %__MODULE__{ :entities => list(GoogleApi.HealthCare.V1beta1.Model.Entity.t()) | nil, :entityMentions => list(GoogleApi.HealthCare.V1beta1.Model.EntityMention.t()) | nil, + :fhirBundle => String.t() | nil, :relationships => list(GoogleApi.HealthCare.V1beta1.Model.EntityMentionRelationship.t()) | nil } field(:entities, as: GoogleApi.HealthCare.V1beta1.Model.Entity, type: :list) field(:entityMentions, as: GoogleApi.HealthCare.V1beta1.Model.EntityMention, type: :list) + field(:fhirBundle) field(:relationships, as: GoogleApi.HealthCare.V1beta1.Model.EntityMentionRelationship, diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation.ex index 07073de709..43fa37d1ef 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation.ex @@ -21,10 +21,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Annotation do ## Attributes - * `annotationSource` (*type:* `GoogleApi.HealthCare.V1beta1.Model.AnnotationSource.t`, *default:* `nil`) - Details of the source. + * `annotationSource` (*type:* `GoogleApi.HealthCare.V1beta1.Model.AnnotationSource.t`, *default:* `nil`) - Required. Details of the source. * `customData` (*type:* `map()`, *default:* `nil`) - Additional information for this annotation record, such as annotator and verifier information or study campaign. * `imageAnnotation` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ImageAnnotation.t`, *default:* `nil`) - Annotations for images. For example, bounding polygons. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. * `resourceAnnotation` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ResourceAnnotation.t`, *default:* `nil`) - Annotations for resource. For example, classification tags. * `textAnnotation` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SensitiveTextAnnotation.t`, *default:* `nil`) - Annotations for sensitive texts. For example, a range that describes the location of sensitive text. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation_store.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation_store.ex index e951265093..9ba2b7af62 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/annotation_store.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.AnnotationStore do ## Attributes * `labels` (*type:* `map()`, *default:* `nil`) - Optional. User-supplied key-value pairs used to organize Annotation 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 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_admin_consents_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_admin_consents_request.ex new file mode 100644 index 0000000000..ca4deac933 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_admin_consents_request.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsRequest do + @moduledoc """ + Request to apply the admin Consent resources for the specified FHIR store. + + ## Attributes + + * `newConsentsList` (*type:* `GoogleApi.HealthCare.V1beta1.Model.AdminConsents.t`, *default:* `nil`) - A new list of admin Consent resources to be applied. Any existing enforced Consents, which are specified in `consent_config.enforced_admin_consents` of the FhirStore, that are not part of this list will be disabled. An empty list is equivalent to clearing or disabling all Consents enforced on the FHIR store. When a FHIR store has `disable_resource_versioning=true` and this list contains a Consent resource that exists in `consent_config.enforced_admin_consents`, the method enforces any updates to the existing resource since the last enforcement. If the existing resource hasn't been updated since the last enforcement, the resource is unaffected. After the method finishes, the resulting consent enforcement model is determined by the contents of the Consent resource(s) when the method was called: * When `disable_resource_versioning=true`, the result is identical to the current resource(s) in the FHIR store. * When `disable_resource_versioning=false`, the result is based on the historical version(s) of the Consent resource(s) at the point in time when the method was called. At most 200 Consents can be specified. + * `validateOnly` (*type:* `boolean()`, *default:* `nil`) - If true, the method only validates Consent resources to make sure they are supported. Otherwise, the method applies the aggregate consent information to update the enforcement model and reindex the FHIR resources. If all Consent resources can be applied successfully, the ApplyAdminConsentsResponse is returned containing the following fields: * `consent_apply_success` to indicate the number of Consent resources applied. * `affected_resources` to indicate the number of resources that might have had their consent access changed. If, however, one or more Consent resources are unsupported or cannot be applied, the method fails and ApplyAdminConsentsErrorDetail is is returned with details about the unsupported Consent resources. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :newConsentsList => GoogleApi.HealthCare.V1beta1.Model.AdminConsents.t() | nil, + :validateOnly => boolean() | nil + } + + field(:newConsentsList, as: GoogleApi.HealthCare.V1beta1.Model.AdminConsents) + field(:validateOnly) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsRequest do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsRequest.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsRequest do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_admin_consents_response.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_admin_consents_response.ex new file mode 100644 index 0000000000..1abc9958fa --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_admin_consents_response.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsResponse do + @moduledoc """ + Response when all admin Consent resources in scope were processed and all affected resources were reindexed successfully. This structure will be included in the response when the operation finishes successfully. + + ## Attributes + + * `affectedResources` (*type:* `String.t`, *default:* `nil`) - The number of resources (including the Consent resources) that may have consent access change. + * `consentApplySuccess` (*type:* `String.t`, *default:* `nil`) - If `validate_only=false` in ApplyAdminConsentsRequest, this counter contains the number of Consent resources that were successfully applied. Otherwise, it is the number of Consent resources that are supported. + * `failedResources` (*type:* `String.t`, *default:* `nil`) - The number of resources (including the Consent resources) that ApplyAdminConsents failed to re-index. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :affectedResources => String.t() | nil, + :consentApplySuccess => String.t() | nil, + :failedResources => String.t() | nil + } + + field(:affectedResources) + field(:consentApplySuccess) + field(:failedResources) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsResponse do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsResponse.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyAdminConsentsResponse do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_consents_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_consents_request.ex new file mode 100644 index 0000000000..e6ce126e71 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_consents_request.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsRequest do + @moduledoc """ + Request to apply the Consent resources for the specified FHIR store. + + ## Attributes + + * `patientScope` (*type:* `GoogleApi.HealthCare.V1beta1.Model.PatientScope.t`, *default:* `nil`) - Optional. Scope down to a list of patients. + * `timeRange` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TimeRange.t`, *default:* `nil`) - Optional. Scope down to patients whose most recent consent changes are in the time range. Can only be used with a versioning store (i.e. when disable_resource_versioning is set to false). + * `validateOnly` (*type:* `boolean()`, *default:* `nil`) - Optional. If true, the method only validates Consent resources to make sure they are supported. When the operation completes, ApplyConsentsResponse is returned where `consent_apply_success` and `consent_apply_failure` indicate supported and unsupported (or invalid) Consent resources, respectively. Otherwise, the method propagates the aggregate consensual information to the patient's resources. Upon success, `affected_resources` in the ApplyConsentsResponse indicates the number of resources that may have consensual access changed. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :patientScope => GoogleApi.HealthCare.V1beta1.Model.PatientScope.t() | nil, + :timeRange => GoogleApi.HealthCare.V1beta1.Model.TimeRange.t() | nil, + :validateOnly => boolean() | nil + } + + field(:patientScope, as: GoogleApi.HealthCare.V1beta1.Model.PatientScope) + field(:timeRange, as: GoogleApi.HealthCare.V1beta1.Model.TimeRange) + field(:validateOnly) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsRequest do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsRequest.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsRequest do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_consents_response.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_consents_response.ex new file mode 100644 index 0000000000..ec0ec3128f --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/apply_consents_response.ex @@ -0,0 +1,55 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsResponse do + @moduledoc """ + Response when all Consent resources in scope were processed and all affected resources were reindexed successfully. This structure is included in the response when the operation finishes successfully. + + ## Attributes + + * `affectedResources` (*type:* `String.t`, *default:* `nil`) - The number of resources (including the Consent resources) that may have consensual access change. + * `consentApplyFailure` (*type:* `String.t`, *default:* `nil`) - If `validate_only = false` in ApplyConsentsRequest, this counter is the number of Consent resources that were failed to apply. Otherwise, it is the number of Consent resources that are not supported or invalid. + * `consentApplySuccess` (*type:* `String.t`, *default:* `nil`) - If `validate_only = false` in ApplyConsentsRequest, this counter is the number of Consent resources that were successfully applied. Otherwise, it is the number of Consent resources that are supported. + * `failedResources` (*type:* `String.t`, *default:* `nil`) - The number of resources (including the Consent resources) that ApplyConsents failed to re-index. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :affectedResources => String.t() | nil, + :consentApplyFailure => String.t() | nil, + :consentApplySuccess => String.t() | nil, + :failedResources => String.t() | nil + } + + field(:affectedResources) + field(:consentApplyFailure) + field(:consentApplySuccess) + field(:failedResources) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsResponse do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsResponse.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ApplyConsentsResponse do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/attribute_definition.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/attribute_definition.ex index 232fe1b3f0..ba1561f93a 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/attribute_definition.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/attribute_definition.ex @@ -26,7 +26,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.AttributeDefinition do * `consentDefaultValues` (*type:* `list(String.t)`, *default:* `nil`) - Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. * `dataMappingDefaultValue` (*type:* `String.t`, *default:* `nil`) - Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. * `description` (*type:* `String.t`, *default:* `nil`) - Optional. A description of the attribute. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/binding.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/binding.ex index bd5712288c..2db9867a3e 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/binding.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/binding.ex @@ -22,8 +22,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Binding do ## Attributes * `condition` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Expr.t`, *default:* `nil`) - 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 principals 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). - * `members` (*type:* `list(String.t)`, *default:* `nil`) - Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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`. - * `role` (*type:* `String.t`, *default:* `nil`) - Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * `members` (*type:* `list(String.t)`, *default:* `nil`) - Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + * `role` (*type:* `String.t`, *default:* `nil`) - Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/blob_storage_info.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/blob_storage_info.ex new file mode 100644 index 0000000000..d29cf35285 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/blob_storage_info.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo do + @moduledoc """ + BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will only be populated for DICOM resources. + + ## Attributes + + * `sizeBytes` (*type:* `String.t`, *default:* `nil`) - Size in bytes of data stored in Blob Storage. + * `storageClass` (*type:* `String.t`, *default:* `nil`) - The storage class in which the Blob data is stored. + * `storageClassUpdateTime` (*type:* `DateTime.t`, *default:* `nil`) - The time at which the storage class was updated. This is used to compute early deletion fees of the resource. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :sizeBytes => String.t() | nil, + :storageClass => String.t() | nil, + :storageClassUpdateTime => DateTime.t() | nil + } + + field(:sizeBytes) + field(:storageClass) + field(:storageClassUpdateTime, as: DateTime) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/blob_storage_settings.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/blob_storage_settings.ex new file mode 100644 index 0000000000..25d02ce677 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/blob_storage_settings.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings do + @moduledoc """ + Settings for data stored in Blob storage. + + ## Attributes + + * `blobStorageClass` (*type:* `String.t`, *default:* `nil`) - The Storage class in which the Blob data is stored. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageClass => String.t() | nil + } + + field(:blobStorageClass) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/character_mask_field.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/character_mask_field.ex index bf0815177d..210d6a1fcb 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/character_mask_field.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/character_mask_field.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CharacterMaskField do @moduledoc """ - Replace field value with masking character. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml + Replace field value with masking character. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_descriptors_option.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_descriptors_option.ex index 40a4956cfd..c4db5d928d 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_descriptors_option.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_descriptors_option.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CleanDescriptorsOption do @moduledoc """ - This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional `InfoType` during inspection. + This option is based on the DICOM Standard's [Clean Descriptors Option](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields. When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile](http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This option uses an additional infoType during inspection. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_field.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_field.ex index c1a7b42e58..13e0ba8f07 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_field.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_field.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CleanTextField do @moduledoc """ - Inspect text and transform sensitive text. Configure using `TextConfig`. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml + Inspect text and transform sensitive text. Configure using TextConfig. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_tag.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_tag.ex index 259ff24f79..b37d7a5884 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_tag.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/clean_text_tag.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CleanTextTag do @moduledoc """ - Inspect text and transform sensitive text. Configurable using `TextConfig`. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent.ex index d684e1e81b..b7c30461ba 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent.ex @@ -24,7 +24,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Consent do * `consentArtifact` (*type:* `String.t`, *default:* `nil`) - Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. * `expireTime` (*type:* `DateTime.t`, *default:* `nil`) - Timestamp in UTC of when this Consent is considered expired. * `metadata` (*type:* `map()`, *default:* `nil`) - Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. * `policies` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1ConsentPolicy.t)`, *default:* `nil`) - Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. * `revisionCreateTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The timestamp that the revision was created. * `revisionId` (*type:* `String.t`, *default:* `nil`) - Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_accessor_scope.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_accessor_scope.ex new file mode 100644 index 0000000000..098f402289 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_accessor_scope.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope do + @moduledoc """ + The accessor scope that describes who can access, for what purpose, in which environment. + + ## Attributes + + * `actor` (*type:* `String.t`, *default:* `nil`) - An individual, group, or access role that identifies the accessor or a characteristic of the accessor. This can be a resource ID (such as `{resourceType}/{id}`) or an external URI. This value must be present. + * `environment` (*type:* `String.t`, *default:* `nil`) - An abstract identifier that describes the environment or conditions under which the accessor is acting. Can be “*” if it applies to all environments. + * `purpose` (*type:* `String.t`, *default:* `nil`) - The intent of data use. Can be “*” if it applies to all purposes. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :actor => String.t() | nil, + :environment => String.t() | nil, + :purpose => String.t() | nil + } + + field(:actor) + field(:environment) + field(:purpose) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_artifact.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_artifact.ex index de2fd8d38d..6193f07900 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_artifact.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_artifact.ex @@ -25,7 +25,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ConsentArtifact do * `consentContentVersion` (*type:* `String.t`, *default:* `nil`) - Optional. An string indicating the version of the consent information shown to the user. * `guardianSignature` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Signature.t`, *default:* `nil`) - Optional. A signature from a guardian. * `metadata` (*type:* `map()`, *default:* `nil`) - Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. * `userId` (*type:* `String.t`, *default:* `nil`) - Required. User's UUID provided by the client. * `userSignature` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Signature.t`, *default:* `nil`) - Optional. User's signature. * `witnessSignature` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Signature.t`, *default:* `nil`) - Optional. A signature from a witness. diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_config.ex new file mode 100644 index 0000000000..93af10c87e --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_config.ex @@ -0,0 +1,63 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ConsentConfig do + @moduledoc """ + Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used. + + ## Attributes + + * `accessDeterminationLogConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig.t`, *default:* `nil`) - Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. + * `accessEnforced` (*type:* `boolean()`, *default:* `nil`) - Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + * `consentHeaderHandling` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling.t`, *default:* `nil`) - Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. + * `enforcedAdminConsents` (*type:* `list(String.t)`, *default:* `nil`) - The versioned names of the enforced admin Consent resource(s), in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`. This field can only be updated using ApplyAdminConsents. + * `version` (*type:* `String.t`, *default:* `nil`) - Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :accessDeterminationLogConfig => + GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig.t() | nil, + :accessEnforced => boolean() | nil, + :consentHeaderHandling => + GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling.t() | nil, + :enforcedAdminConsents => list(String.t()) | nil, + :version => String.t() | nil + } + + field(:accessDeterminationLogConfig, + as: GoogleApi.HealthCare.V1beta1.Model.AccessDeterminationLogConfig + ) + + field(:accessEnforced) + field(:consentHeaderHandling, as: GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling) + field(:enforcedAdminConsents, type: :list) + field(:version) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ConsentConfig do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ConsentConfig.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ConsentConfig do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_header_handling.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_header_handling.ex new file mode 100644 index 0000000000..ff596d703d --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/consent_header_handling.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling do + @moduledoc """ + How the server handles the consent header. + + ## Attributes + + * `profile` (*type:* `String.t`, *default:* `nil`) - Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :profile => String.t() | nil + } + + field(:profile) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ConsentHeaderHandling do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/contextual_deid_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/contextual_deid_config.ex index 086e310513..49245632ca 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/contextual_deid_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/contextual_deid_config.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ContextualDeidConfig do @moduledoc """ - The fields that aren't marked `Keep` or `CleanText` in the `BASIC` profile are collected into a contextual phrase list. For fields marked `CleanText`, the process attempts to transform phrases matching these contextual entries. These contextual phrases are replaced with the token "[CTX]". This feature uses an additional InfoType during inspection. + Fields that don't match a KeepField or CleanTextField `action` in the BASIC profile are collected into a contextual phrase list. For fields that match a CleanTextField `action` in FieldMetadata or ProfileType, the process attempts to transform phrases matching these contextual entries. These contextual phrases are replaced with the token "[CTX]". This feature uses an additional InfoType during inspection. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/create_message_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/create_message_request.ex index 866b2957c3..c1db56094b 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/create_message_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/create_message_request.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CreateMessageRequest do ## Attributes - * `message` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Message.t`, *default:* `nil`) - HL7v2 message. + * `message` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Message.t`, *default:* `nil`) - Required. HL7v2 message. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_config.ex index 731ac2dcb6..340247a152 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_config.ex @@ -21,8 +21,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CryptoHashConfig do ## Attributes - * `cryptoKey` (*type:* `String.t`, *default:* `nil`) - 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 when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. - * `kmsWrapped` (*type:* `GoogleApi.HealthCare.V1beta1.Model.KmsWrappedCryptoKey.t`, *default:* `nil`) - KMS wrapped key. Must not be set if `crypto_key` is set. + * `cryptoKey` (*type:* `String.t`, *default:* `nil`) - 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 when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set. + * `kmsWrapped` (*type:* `GoogleApi.HealthCare.V1beta1.Model.KmsWrappedCryptoKey.t`, *default:* `nil`) - KMS wrapped key. Must not be set if crypto_key is set. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_field.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_field.ex index c7ed63afc5..a41b96cacf 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_field.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/crypto_hash_field.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.CryptoHashField do @moduledoc """ - Replace field value with a hash of that value. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml + Replace field value with a hash of that value. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/dataset.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/dataset.ex index 63069c7e7d..fa5a82cc76 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/dataset.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/dataset.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Dataset do ## Attributes - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. * `timeZone` (*type:* `String.t`, *default:* `nil`) - The default timezone used by this dataset. Must be a either a valid IANA time zone name such as "America/New_York" or empty, which defaults to UTC. This is used for parsing times in resources, such as HL7 messages, where no explicit timezone is specified. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_config.ex index 8bad5ed053..8748b13e0b 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_config.ex @@ -21,8 +21,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DateShiftConfig do ## Attributes - * `cryptoKey` (*type:* `String.t`, *default:* `nil`) - 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 de-identification operation and is used when neither `crypto_key` nor `kms_wrapped` is specified. Must not be set if `kms_wrapped` is set. - * `kmsWrapped` (*type:* `GoogleApi.HealthCare.V1beta1.Model.KmsWrappedCryptoKey.t`, *default:* `nil`) - KMS wrapped key. Must not be set if `crypto_key` is set. + * `cryptoKey` (*type:* `String.t`, *default:* `nil`) - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set. + * `kmsWrapped` (*type:* `GoogleApi.HealthCare.V1beta1.Model.KmsWrappedCryptoKey.t`, *default:* `nil`) - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_field.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_field.ex index 8c8d1759eb..c207fadef9 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_field.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/date_shift_field.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DateShiftField do @moduledoc """ - Shift the date by a randomized number of days. See [date shifting](https://cloud.google.com/dlp/docs/concepts-date-shifting) for more information. Supported [types](https://www.hl7.org/fhir/datatypes.html): Date, DateTime + Shift the date by a randomized number of days. See [date shifting](https://cloud.google.com/dlp/docs/concepts-date-shifting) for more information. Supported [types](https://www.hl7.org/fhir/datatypes.html): Date, DateTime. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_config.ex index 1357058d4f..c1eedb0a14 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_config.ex @@ -29,6 +29,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig do * `image` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ImageConfig.t`, *default:* `nil`) - Configures the de-identification of image pixels in the source_dataset. Deprecated. Use `dicom_tag_config.options.clean_image` instead. * `operationMetadata` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyOperationMetadata.t`, *default:* `nil`) - Details about the work the de-identify operation performed. * `text` (*type:* `GoogleApi.HealthCare.V1beta1.Model.TextConfig.t`, *default:* `nil`) - Configures de-identification of text wherever it is found in the source_dataset. + * `useRegionalDataProcessing` (*type:* `boolean()`, *default:* `nil`) - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. """ use GoogleApi.Gax.ModelBase @@ -42,7 +43,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig do :image => GoogleApi.HealthCare.V1beta1.Model.ImageConfig.t() | nil, :operationMetadata => GoogleApi.HealthCare.V1beta1.Model.DeidentifyOperationMetadata.t() | nil, - :text => GoogleApi.HealthCare.V1beta1.Model.TextConfig.t() | nil + :text => GoogleApi.HealthCare.V1beta1.Model.TextConfig.t() | nil, + :useRegionalDataProcessing => boolean() | nil } field(:annotation, as: GoogleApi.HealthCare.V1beta1.Model.AnnotationConfig) @@ -53,6 +55,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig do field(:image, as: GoogleApi.HealthCare.V1beta1.Model.ImageConfig) field(:operationMetadata, as: GoogleApi.HealthCare.V1beta1.Model.DeidentifyOperationMetadata) field(:text, as: GoogleApi.HealthCare.V1beta1.Model.TextConfig) + field(:useRegionalDataProcessing) end defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig do diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dataset_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dataset_request.ex index 7daf7797c1..9e0b58729e 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dataset_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dataset_request.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DeidentifyDatasetRequest do ## Attributes * `config` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig.t`, *default:* `nil`) - Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. - * `destinationDataset` (*type:* `String.t`, *default:* `nil`) - The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. + * `destinationDataset` (*type:* `String.t`, *default:* `nil`) - Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. * `gcsConfigUri` (*type:* `String.t`, *default:* `nil`) - Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dicom_store_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dicom_store_request.ex index 85ebf72841..0519ca2fbb 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dicom_store_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_dicom_store_request.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DeidentifyDicomStoreRequest do ## Attributes * `config` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig.t`, *default:* `nil`) - Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. - * `destinationStore` (*type:* `String.t`, *default:* `nil`) - 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 location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. + * `destinationStore` (*type:* `String.t`, *default:* `nil`) - Required. 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 location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. * `filterConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DicomFilterConfig.t`, *default:* `nil`) - Filter configuration. * `gcsConfigUri` (*type:* `String.t`, *default:* `nil`) - Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_fhir_store_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_fhir_store_request.ex index 2eebbd7799..22f636b8cb 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_fhir_store_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/deidentify_fhir_store_request.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DeidentifyFhirStoreRequest do ## Attributes * `config` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DeidentifyConfig.t`, *default:* `nil`) - Deidentify configuration. Only one of `config` and `gcs_config_uri` can be specified. - * `destinationStore` (*type:* `String.t`, *default:* `nil`) - The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. + * `destinationStore` (*type:* `String.t`, *default:* `nil`) - Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. * `gcsConfigUri` (*type:* `String.t`, *default:* `nil`) - Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. * `resourceFilter` (*type:* `GoogleApi.HealthCare.V1beta1.Model.FhirFilter.t`, *default:* `nil`) - A filter specifying the resources to include in the output. If not specified, all resources are included in the output. * `skipModifiedResources` (*type:* `boolean()`, *default:* `nil`) - If true, skips resources that are created or modified after the de-identify operation is created. diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store.ex index 1757803c78..b6eb74ba01 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store.ex @@ -22,9 +22,9 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.DicomStore do ## Attributes * `labels` (*type:* `map()`, *default:* `nil`) - 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.NotificationConfig.t`, *default:* `nil`) - Notification destination for new DICOM instances. Supplied by the client. - * `streamConfigs` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DicomStreamConfig.t)`, *default:* `nil`) - A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. + * `streamConfigs` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DicomStreamConfig.t)`, *default:* `nil`) - Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store_metrics.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store_metrics.ex new file mode 100644 index 0000000000..532231385a --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/dicom_store_metrics.ex @@ -0,0 +1,61 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics do + @moduledoc """ + DicomStoreMetrics contains metrics describing a DICOM store. + + ## Attributes + + * `blobStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total blob storage bytes for all instances in the store. + * `instanceCount` (*type:* `String.t`, *default:* `nil`) - Number of instances in the store. + * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * `seriesCount` (*type:* `String.t`, *default:* `nil`) - Number of series in the store. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total structured storage bytes for all instances in the store. + * `studyCount` (*type:* `String.t`, *default:* `nil`) - Number of studies in the store. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSizeBytes => String.t() | nil, + :instanceCount => String.t() | nil, + :name => String.t() | nil, + :seriesCount => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil, + :studyCount => String.t() | nil + } + + field(:blobStorageSizeBytes) + field(:instanceCount) + field(:name) + field(:seriesCount) + field(:structuredStorageSizeBytes) + field(:studyCount) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.DicomStoreMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/entity_mention.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/entity_mention.ex index f2f912bd20..d27834b6e6 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/entity_mention.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/entity_mention.ex @@ -21,9 +21,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.EntityMention do ## Attributes + * `additionalInfo` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.Feature.t)`, *default:* `nil`) - Additional information about the entity mention. For example, for an entity mention of type `DATE` this can be its more specific date types from the following list: `ADMISSION_DATE`, `CONSULTATION_DATE`, `DISCHARGE_DATE`, `SERVICE_DATE`, `VISIT_DATE`, `DIAGNOSIS_DATE`, `MED_STARTED_DATE`, `MED_ENDED_DATE`, `NOTE_DATE`, `PROCEDURE_DATE`, `RADIATION_STARTED_DATE`, `RADIATION_ENDED_DATE`, `STAGE_DATE` * `certaintyAssessment` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Feature.t`, *default:* `nil`) - The certainty assessment of the entity mention. Its value is one of: LIKELY, SOMEWHAT_LIKELY, UNCERTAIN, SOMEWHAT_UNLIKELY, UNLIKELY, CONDITIONAL * `confidence` (*type:* `float()`, *default:* `nil`) - The model's confidence in this entity mention annotation. A number between 0 and 1. - * `linkedEntities` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.LinkedEntity.t)`, *default:* `nil`) - linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence.it + * `linkedEntities` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.LinkedEntity.t)`, *default:* `nil`) - linked_entities are candidate ontological concepts that this entity mention may refer to. They are sorted by decreasing confidence. * `mentionId` (*type:* `String.t`, *default:* `nil`) - mention_id uniquely identifies each entity mention in a single response. * `subject` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Feature.t`, *default:* `nil`) - The subject this entity mention relates to. Its value is one of: PATIENT, FAMILY_MEMBER, OTHER * `temporalAssessment` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Feature.t`, *default:* `nil`) - How this entity mention relates to the subject temporally. Its value is one of: CURRENT, CLINICAL_HISTORY, FAMILY_HISTORY, UPCOMING, ALLERGY @@ -34,6 +35,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.EntityMention do use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ + :additionalInfo => list(GoogleApi.HealthCare.V1beta1.Model.Feature.t()) | nil, :certaintyAssessment => GoogleApi.HealthCare.V1beta1.Model.Feature.t() | nil, :confidence => float() | nil, :linkedEntities => list(GoogleApi.HealthCare.V1beta1.Model.LinkedEntity.t()) | nil, @@ -44,6 +46,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.EntityMention do :type => String.t() | nil } + field(:additionalInfo, as: GoogleApi.HealthCare.V1beta1.Model.Feature, type: :list) field(:certaintyAssessment, as: GoogleApi.HealthCare.V1beta1.Model.Feature) field(:confidence) field(:linkedEntities, as: GoogleApi.HealthCare.V1beta1.Model.LinkedEntity, type: :list) diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/evaluate_annotation_store_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/evaluate_annotation_store_request.ex index 865263a924..964fa7cccc 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/evaluate_annotation_store_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/evaluate_annotation_store_request.ex @@ -24,7 +24,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.EvaluateAnnotationStoreRequest do * `bigqueryDestination` (*type:* `GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination.t`, *default:* `nil`) - The BigQuery table where the server writes the output. BigQueryDestination requires the `roles/bigquery.dataEditor` and `roles/bigquery.jobUser` Cloud IAM roles. * `evalInfoTypeMapping` (*type:* `map()`, *default:* `nil`) - Optional. InfoType mapping for `eval_store`. Different resources can map to the same infoType. For example, `PERSON_NAME`, `PERSON`, `NAME`, and `HUMAN` are different. To map all of these into a single infoType (such as `PERSON_NAME`), specify the following mapping: ``` info_type_mapping["PERSON"] = "PERSON_NAME" info_type_mapping["NAME"] = "PERSON_NAME" info_type_mapping["HUMAN"] = "PERSON_NAME" ``` Unmentioned infoTypes, such as `DATE`, are treated as identity mapping. For example: ``` info_type_mapping["DATE"] = "DATE" ``` InfoTypes are case-insensitive. * `goldenInfoTypeMapping` (*type:* `map()`, *default:* `nil`) - Optional. Similar to `eval_info_type_mapping`, infoType mapping for `golden_store`. - * `goldenStore` (*type:* `String.t`, *default:* `nil`) - The Annotation store to use as ground truth, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * `goldenStore` (*type:* `String.t`, *default:* `nil`) - Required. The Annotation store to use as ground truth, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. * `infoTypeConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.InfoTypeConfig.t`, *default:* `nil`) - """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_consent_info.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_consent_info.ex new file mode 100644 index 0000000000..d4089fa920 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_consent_info.ex @@ -0,0 +1,70 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo do + @moduledoc """ + The enforcing consent's metadata. + + ## Attributes + + * `cascadeOrigins` (*type:* `list(String.t)`, *default:* `nil`) - The compartment base resources that matched a cascading policy. Each resource has the following format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/{resource_type}/{resource_id}` + * `consentResource` (*type:* `String.t`, *default:* `nil`) - The resource name of this consent resource. Format: `projects/{projectId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/{resourceType}/{id}`. + * `enforcementTime` (*type:* `DateTime.t`, *default:* `nil`) - Last enforcement timestamp of this consent resource. + * `matchingAccessorScopes` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope.t)`, *default:* `nil`) - A list of all the matching accessor scopes of this consent policy that enforced ExplainDataAccessConsentScope.accessor_scope. + * `patientConsentOwner` (*type:* `String.t`, *default:* `nil`) - The patient owning the consent (only applicable for patient consents), in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{patient_id}` + * `type` (*type:* `String.t`, *default:* `nil`) - The policy type of consent resource (e.g. PATIENT, ADMIN). + * `variants` (*type:* `list(String.t)`, *default:* `nil`) - The consent's variant combinations. A single consent may have multiple variants. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :cascadeOrigins => list(String.t()) | nil, + :consentResource => String.t() | nil, + :enforcementTime => DateTime.t() | nil, + :matchingAccessorScopes => + list(GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope.t()) | nil, + :patientConsentOwner => String.t() | nil, + :type => String.t() | nil, + :variants => list(String.t()) | nil + } + + field(:cascadeOrigins, type: :list) + field(:consentResource) + field(:enforcementTime, as: DateTime) + + field(:matchingAccessorScopes, + as: GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope, + type: :list + ) + + field(:patientConsentOwner) + field(:type) + field(:variants, type: :list) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_consent_scope.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_consent_scope.ex new file mode 100644 index 0000000000..a679b4bb95 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_consent_scope.ex @@ -0,0 +1,65 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope do + @moduledoc """ + A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent. + + ## Attributes + + * `accessorScope` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope.t`, *default:* `nil`) - The accessor scope that describes who can access, for what purpose, and in which environment. + * `decision` (*type:* `String.t`, *default:* `nil`) - Whether the current consent scope is permitted or denied access on the requested resource. + * `enforcingConsents` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo.t)`, *default:* `nil`) - Metadata of the consent resources that enforce the consent scope's access. + * `exceptions` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope.t)`, *default:* `nil`) - Other consent scopes that created exceptions within this scope. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :accessorScope => GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope.t() | nil, + :decision => String.t() | nil, + :enforcingConsents => + list(GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo.t()) | nil, + :exceptions => + list(GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope.t()) | nil + } + + field(:accessorScope, as: GoogleApi.HealthCare.V1beta1.Model.ConsentAccessorScope) + field(:decision) + + field(:enforcingConsents, + as: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentInfo, + type: :list + ) + + field(:exceptions, + as: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope, + type: :list + ) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_response.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_response.ex new file mode 100644 index 0000000000..03348aaadc --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/explain_data_access_response.ex @@ -0,0 +1,54 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse do + @moduledoc """ + List of consent scopes that are applicable to the explained access on a given resource. + + ## Attributes + + * `consentScopes` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope.t)`, *default:* `nil`) - List of applicable consent scopes. Sorted in order of actor such that scopes belonging to the same actor will be adjacent to each other in the list. + * `warning` (*type:* `String.t`, *default:* `nil`) - Warnings associated with this response. It inform user with exceeded scope limit errors. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :consentScopes => + list(GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope.t()) | nil, + :warning => String.t() | nil + } + + field(:consentScopes, + as: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessConsentScope, + type: :list + ) + + field(:warning) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.ExplainDataAccessResponse do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/export_messages_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/export_messages_request.ex index 209080a663..f9e34942bc 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/export_messages_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/export_messages_request.ex @@ -22,7 +22,9 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ExportMessagesRequest do ## Attributes * `endTime` (*type:* `DateTime.t`, *default:* `nil`) - The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used. This value has to come after the `start_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. + * `filter` (*type:* `String.t`, *default:* `nil`) - Restricts messages exported to those matching a filter, only applicable to PubsubDestination. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in the `yyyy-mm-dd` format. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, and is just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. Note: The filter will be applied to every message in the HL7v2 store whose `send_time` lies in the range defined by the `start_time` and the `end_time`. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified `start_time` and `end_time` range. * `gcsDestination` (*type:* `GoogleApi.HealthCare.V1beta1.Model.GcsDestination.t`, *default:* `nil`) - Export to a Cloud Storage destination. + * `pubsubDestination` (*type:* `GoogleApi.HealthCare.V1beta1.Model.PubsubDestination.t`, *default:* `nil`) - Export messages to a Pub/Sub topic. * `startTime` (*type:* `DateTime.t`, *default:* `nil`) - The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used. This value has to come before the `end_time` defined below. Only messages whose `send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive) are exported. """ @@ -30,12 +32,16 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ExportMessagesRequest do @type t :: %__MODULE__{ :endTime => DateTime.t() | nil, + :filter => String.t() | nil, :gcsDestination => GoogleApi.HealthCare.V1beta1.Model.GcsDestination.t() | nil, + :pubsubDestination => GoogleApi.HealthCare.V1beta1.Model.PubsubDestination.t() | nil, :startTime => DateTime.t() | nil } field(:endTime, as: DateTime) + field(:filter) field(:gcsDestination, as: GoogleApi.HealthCare.V1beta1.Model.GcsDestination) + field(:pubsubDestination, as: GoogleApi.HealthCare.V1beta1.Model.PubsubDestination) field(:startTime, as: DateTime) end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_field_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_field_config.ex index a335bb6157..fd8b7740b8 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_field_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_field_config.ex @@ -21,8 +21,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.FhirFieldConfig do ## Attributes - * `fieldMetadataList` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata.t)`, *default:* `nil`) - 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 will be processed according to `keep_extensions`. If a field can be matched by more than one `FieldMetadata`, the first `FieldMetadata.Action` is applied. Overrides `options` and `profile`. - * `options` (*type:* `GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyOptions.t`, *default:* `nil`) - Specifies additional options, overriding the base `profile`. + * `fieldMetadataList` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata.t)`, *default:* `nil`) - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata `action` is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadata `action`, the first `action` option is applied. Overrides options and the union field `profile` in FhirFieldConfig. + * `options` (*type:* `GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyOptions.t`, *default:* `nil`) - Specifies additional options, overriding the base ProfileType. * `profileType` (*type:* `String.t`, *default:* `nil`) - Base profile type for handling FHIR fields. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_notification_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_notification_config.ex index e1286710fc..c7ad35e767 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_notification_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_notification_config.ex @@ -21,19 +21,22 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.FhirNotificationConfig do ## Attributes - * `pubsubTopic` (*type:* `String.t`, *default:* `nil`) - The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that 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. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + * `pubsubTopic` (*type:* `String.t`, *default:* `nil`) - The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that 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. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). * `sendFullResource` (*type:* `boolean()`, *default:* `nil`) - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + * `sendPreviousResourceOnDelete` (*type:* `boolean()`, *default:* `nil`) - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. """ use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ :pubsubTopic => String.t() | nil, - :sendFullResource => boolean() | nil + :sendFullResource => boolean() | nil, + :sendPreviousResourceOnDelete => boolean() | nil } field(:pubsubTopic) field(:sendFullResource) + field(:sendPreviousResourceOnDelete) end defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.FhirNotificationConfig do diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_output.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_output.ex index 670f45578f..00c6c8586c 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_output.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_output.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.FhirOutput do ## Attributes - * `fhirStore` (*type:* `String.t`, *default:* `nil`) - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set `enable_update_create` to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations. + * `fhirStore` (*type:* `String.t`, *default:* `nil`) - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store.ex index 244eb300ec..8d6b2b4268 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store.ex @@ -22,27 +22,31 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.FhirStore do ## Attributes * `complexDataTypeReferenceParsing` (*type:* `String.t`, *default:* `nil`) - Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. + * `consentConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ConsentConfig.t`, *default:* `nil`) - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources. * `defaultSearchHandlingStrict` (*type:* `boolean()`, *default:* `nil`) - If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. * `disableReferentialIntegrity` (*type:* `boolean()`, *default:* `nil`) - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. * `disableResourceVersioning` (*type:* `boolean()`, *default:* `nil`) - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. + * `enableHistoryModifications` (*type:* `boolean()`, *default:* `nil`) - Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. * `enableUpdateCreate` (*type:* `boolean()`, *default:* `nil`) - Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. * `labels` (*type:* `map()`, *default:* `nil`) - User-supplied key-value pairs used to organize FHIR 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. - * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.NotificationConfig.t`, *default:* `nil`) - If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". + * `name` (*type:* `String.t`, *default:* `nil`) - Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.NotificationConfig.t`, *default:* `nil`) - Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". * `notificationConfigs` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.FhirNotificationConfig.t)`, *default:* `nil`) - Specifies where and whether to send notifications upon changes to a Fhir store. * `searchConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SearchConfig.t`, *default:* `nil`) - Configuration for how FHIR resources can be searched. * `streamConfigs` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.StreamConfig.t)`, *default:* `nil`) - A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. * `validationConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ValidationConfig.t`, *default:* `nil`) - Configuration for how to validate incoming FHIR resources against configured profiles. - * `version` (*type:* `String.t`, *default:* `nil`) - Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. + * `version` (*type:* `String.t`, *default:* `nil`) - Required. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. """ use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ :complexDataTypeReferenceParsing => String.t() | nil, + :consentConfig => GoogleApi.HealthCare.V1beta1.Model.ConsentConfig.t() | nil, :defaultSearchHandlingStrict => boolean() | nil, :disableReferentialIntegrity => boolean() | nil, :disableResourceVersioning => boolean() | nil, + :enableHistoryModifications => boolean() | nil, :enableUpdateCreate => boolean() | nil, :labels => map() | nil, :name => String.t() | nil, @@ -56,9 +60,11 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.FhirStore do } field(:complexDataTypeReferenceParsing) + field(:consentConfig, as: GoogleApi.HealthCare.V1beta1.Model.ConsentConfig) field(:defaultSearchHandlingStrict) field(:disableReferentialIntegrity) field(:disableResourceVersioning) + field(:enableHistoryModifications) field(:enableUpdateCreate) field(:labels, type: :map) field(:name) diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store_metric.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store_metric.ex new file mode 100644 index 0000000000..f385b681e0 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store_metric.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric do + @moduledoc """ + Count of resources and total storage size by type for a given FHIR store. + + ## Attributes + + * `count` (*type:* `String.t`, *default:* `nil`) - The total count of FHIR resources in the store of this resource type. + * `resourceType` (*type:* `String.t`, *default:* `nil`) - The FHIR resource type this metric applies to. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - The total amount of structured storage used by FHIR resources of this resource type in the store. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :count => String.t() | nil, + :resourceType => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil + } + + field(:count) + field(:resourceType) + field(:structuredStorageSizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store_metrics.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store_metrics.ex new file mode 100644 index 0000000000..5a91ecc87d --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/fhir_store_metrics.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics do + @moduledoc """ + List of metrics for a given FHIR store. + + ## Attributes + + * `metrics` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric.t)`, *default:* `nil`) - List of FhirStoreMetric by resource type. + * `name` (*type:* `String.t`, *default:* `nil`) - The resource name of the FHIR store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :metrics => list(GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric.t()) | nil, + :name => String.t() | nil + } + + field(:metrics, as: GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetric, type: :list) + field(:name) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.FhirStoreMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_field_metadata.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_field_metadata.ex index 64a0cbd2a3..dc1c2bb9fa 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_field_metadata.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_field_metadata.ex @@ -21,12 +21,12 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1Deident ## Attributes - * `characterMaskField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CharacterMaskField.t`, *default:* `nil`) - Replace the field's value with a masking character. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml - * `cleanTextField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CleanTextField.t`, *default:* `nil`) - Inspect the field's text and transform sensitive text. Configure using `TextConfig`. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml - * `cryptoHashField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CryptoHashField.t`, *default:* `nil`) - Replace field value with a hash of that value. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml - * `dateShiftField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DateShiftField.t`, *default:* `nil`) - Shift the date by a randomized number of days. See [date shifting](https://cloud.google.com/dlp/docs/concepts-date-shifting) for more information. Supported [types](https://www.hl7.org/fhir/datatypes.html): Date, DateTime + * `characterMaskField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CharacterMaskField.t`, *default:* `nil`) - Replace the field's value with a masking character. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. + * `cleanTextField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CleanTextField.t`, *default:* `nil`) - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. + * `cryptoHashField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CryptoHashField.t`, *default:* `nil`) - Replace field value with a hash of that value. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. + * `dateShiftField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DateShiftField.t`, *default:* `nil`) - Shift the date by a randomized number of days. See [date shifting](https://cloud.google.com/dlp/docs/concepts-date-shifting) for more information. Supported [types](https://www.hl7.org/fhir/datatypes.html): Date, DateTime. * `keepField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.KeepField.t`, *default:* `nil`) - Keep the field unchanged. - * `paths` (*type:* `list(String.t)`, *default:* `nil`) - List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partialkk matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined, for example "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported [types](https://www.hl7.org/fhir/datatypes.html) are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for example HumanName.given, HumanName.family) can be omitted. + * `paths` (*type:* `list(String.t)`, *default:* `nil`) - List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR [type](https://www.hl7.org/fhir/datatypes.html) name. All types begin with an upper case letter. For example, the resource field `Patient.Address.city`, which uses a [string](https://www.hl7.org/fhir/datatypes-definitions.html#Address.city) type, can be matched by `Patient.Address.String`. Partial matching is supported. For example, `Patient.Address.city` can be matched by `Address.city` (with `Patient` omitted). Partial matching and type matching can be combined, for example `Patient.Address.city` can be matched by `Address.String`. For "choice" types (those defined in the FHIR spec with the format `field[x]`), use two separate components. For example, `deceasedAge.unit` is matched by `Deceased.Age.unit`. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for example `HumanName.given`, `HumanName.family`) can be omitted. * `removeField` (*type:* `GoogleApi.HealthCare.V1beta1.Model.RemoveField.t`, *default:* `nil`) - Remove the field. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_options.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_options.ex index ce0c1be327..24f81cf4c1 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_options.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/google_cloud_healthcare_v1beta1_deidentify_options.ex @@ -17,14 +17,14 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DeidentifyOptions do @moduledoc """ - Specifies additional options to apply to the base `profile`. + Specifies additional options to apply to the base ProfileType. ## Attributes - * `characterMaskConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CharacterMaskConfig.t`, *default:* `nil`) - Character mask config for `CharacterMaskField` `FieldMetadatas`. + * `characterMaskConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CharacterMaskConfig.t`, *default:* `nil`) - Character mask config for CharacterMaskField. * `contextualDeid` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ContextualDeidConfig.t`, *default:* `nil`) - Configure contextual de-id. - * `cryptoHashConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CryptoHashConfig.t`, *default:* `nil`) - Crypo hash config for `CharacterMaskField` `FieldMetadatas`. - * `dateShiftConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DateShiftConfig.t`, *default:* `nil`) - Date shifting config for `CharacterMaskField` `FieldMetadatas`. + * `cryptoHashConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.CryptoHashConfig.t`, *default:* `nil`) - Crypto hash config for CharacterMaskField. + * `dateShiftConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DateShiftConfig.t`, *default:* `nil`) - Date shifting config for CharacterMaskField. * `keepExtensions` (*type:* `GoogleApi.HealthCare.V1beta1.Model.KeepExtensionsConfig.t`, *default:* `nil`) - Configure keeping extensions by default. """ diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store.ex index 023b3786a1..04449bc9c2 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Hl7V2Store do ## Attributes * `labels` (*type:* `map()`, *default:* `nil`) - User-supplied key-value pairs used to organize HL7v2 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. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * `name` (*type:* `String.t`, *default:* `nil`) - Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. * `notificationConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.NotificationConfig.t`, *default:* `nil`) - The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications are sent. Supplied by the client. * `notificationConfigs` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.Hl7V2NotificationConfig.t)`, *default:* `nil`) - A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. * `parserConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ParserConfig.t`, *default:* `nil`) - The configuration for the parser. It determines how the server parses the messages. diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store_metric.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store_metric.ex new file mode 100644 index 0000000000..b60d234df0 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store_metric.ex @@ -0,0 +1,52 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric do + @moduledoc """ + Count of messages and total storage size by type for a given HL7 store. + + ## Attributes + + * `count` (*type:* `String.t`, *default:* `nil`) - The total count of HL7v2 messages in the store for the given message type. + * `messageType` (*type:* `String.t`, *default:* `nil`) - The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - The total amount of structured storage used by HL7v2 messages of this message type in the store. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :count => String.t() | nil, + :messageType => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil + } + + field(:count) + field(:messageType) + field(:structuredStorageSizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store_metrics.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store_metrics.ex new file mode 100644 index 0000000000..5fcb763c38 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/hl7_v2_store_metrics.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics do + @moduledoc """ + List of metrics for a given HL7v2 store. + + ## Attributes + + * `metrics` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric.t)`, *default:* `nil`) - List of HL7v2 store metrics by message type. + * `name` (*type:* `String.t`, *default:* `nil`) - The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :metrics => list(GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric.t()) | nil, + :name => String.t() | nil + } + + field(:metrics, as: GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetric, type: :list) + field(:name) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.Hl7V2StoreMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/import_dicom_data_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/import_dicom_data_request.ex index 5052f74f54..16bc303a69 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/import_dicom_data_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/import_dicom_data_request.ex @@ -21,17 +21,22 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ImportDicomDataRequest do ## Attributes + * `blobStorageSettings` (*type:* `GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings.t`, *default:* `nil`) - Optional. The blob storage settings for the data imported by this operation. * `gcsSource` (*type:* `GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DicomGcsSource.t`, *default:* `nil`) - Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage location. """ use GoogleApi.Gax.ModelBase @type t :: %__MODULE__{ + :blobStorageSettings => + GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings.t() | nil, :gcsSource => GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DicomGcsSource.t() | nil } + field(:blobStorageSettings, as: GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings) + field(:gcsSource, as: GoogleApi.HealthCare.V1beta1.Model.GoogleCloudHealthcareV1beta1DicomGcsSource ) diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/ingest_message_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/ingest_message_request.ex index 1630a5f676..3fd2a839ca 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/ingest_message_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/ingest_message_request.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.IngestMessageRequest do ## Attributes - * `message` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Message.t`, *default:* `nil`) - HL7v2 message to ingest. + * `message` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Message.t`, *default:* `nil`) - Required. HL7v2 message to ingest. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/keep_extensions_config.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/keep_extensions_config.ex index f87df48746..b36b842e8e 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/keep_extensions_config.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/keep_extensions_config.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.KeepExtensionsConfig do @moduledoc """ - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If provided, all extensions are preserved during de-identification by default. If unspecified, all extensions are removed during de-identification by default. + The behavior for handling FHIR extensions that aren't otherwise specified for de-identification. If provided, all extensions are preserved during de-identification by default. If unspecified, all extensions are removed during de-identification by default. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/location.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/location.ex index d746f7fa55..9b478f00f9 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/location.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/location.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Location do @moduledoc """ - A resource that represents Google Cloud Platform location. + A resource that represents a Google Cloud location. ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/message.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/message.ex index 253073d346..936b8da86c 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/message.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/message.ex @@ -22,10 +22,10 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Message do ## Attributes * `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The datetime when the message was created. Set by the server. - * `data` (*type:* `String.t`, *default:* `nil`) - Raw message bytes. + * `data` (*type:* `String.t`, *default:* `nil`) - Required. Raw message bytes. * `labels` (*type:* `map()`, *default:* `nil`) - User-supplied key-value pairs used to organize HL7v2 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. * `messageType` (*type:* `String.t`, *default:* `nil`) - The message type for this message. MSH-9.1. - * `name` (*type:* `String.t`, *default:* `nil`) - Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. + * `name` (*type:* `String.t`, *default:* `nil`) - Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. * `parsedData` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ParsedData.t`, *default:* `nil`) - Output only. The parsed version of the raw message data. * `patientIds` (*type:* `list(GoogleApi.HealthCare.V1beta1.Model.PatientId.t)`, *default:* `nil`) - All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. * `schematizedData` (*type:* `GoogleApi.HealthCare.V1beta1.Model.SchematizedData.t`, *default:* `nil`) - The parsed version of the raw message data schematized according to this store's schemas and type definitions. diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/operation.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/operation.ex index da2fd00921..81ca3c102e 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/operation.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/operation.ex @@ -25,7 +25,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Operation do * `error` (*type:* `GoogleApi.HealthCare.V1beta1.Model.Status.t`, *default:* `nil`) - The error result of the operation in case of failure or cancellation. * `metadata` (*type:* `map()`, *default:* `nil`) - 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. * `name` (*type:* `String.t`, *default:* `nil`) - 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` (*type:* `map()`, *default:* `nil`) - 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`. + * `response` (*type:* `map()`, *default:* `nil`) - The normal, successful response of the operation. 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`. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/operation_metadata.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/operation_metadata.ex index 87139bd410..ebf1d301b3 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/operation_metadata.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/operation_metadata.ex @@ -25,8 +25,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.OperationMetadata do * `cancelRequested` (*type:* `boolean()`, *default:* `nil`) - Specifies if cancellation was requested for the operation. * `counter` (*type:* `GoogleApi.HealthCare.V1beta1.Model.ProgressCounter.t`, *default:* `nil`) - * `createTime` (*type:* `DateTime.t`, *default:* `nil`) - The time at which the operation was created by the API. - * `endTime` (*type:* `DateTime.t`, *default:* `nil`) - The time at which execution was completed. - * `logsUrl` (*type:* `String.t`, *default:* `nil`) - A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). + * `endTime` (*type:* `DateTime.t`, *default:* `nil`) - The time at which execution workloads were completed. Some tasks will complete after this time such as logging audit logs. + * `logsUrl` (*type:* `String.t`, *default:* `nil`) - A link to audit and error logs in the log viewer. Error logs are generated only by some operations, listed at [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The `end_time` specified in this URL may not match the end time on the metadata because logs are written asynchronously from execution. """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/patient_scope.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/patient_scope.ex new file mode 100644 index 0000000000..7fbf227bc5 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/patient_scope.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.PatientScope do + @moduledoc """ + Apply consents given by a list of patients. + + ## Attributes + + * `patientIds` (*type:* `list(String.t)`, *default:* `nil`) - Optional. The list of patient IDs whose Consent resources will be enforced. At most 10,000 patients can be specified. An empty list is equivalent to all patients (meaning the entire FHIR store). + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :patientIds => list(String.t()) | nil + } + + field(:patientIds, type: :list) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.PatientScope do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.PatientScope.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.PatientScope do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/policy.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/policy.ex index 313236f283..9d2af76828 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/policy.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/policy.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.Policy do @moduledoc """ - 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`, or principals, to a single `role`. Principals 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/). + 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`, or principals, to a single `role`. Principals 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/). ## Attributes diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/progress_counter.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/progress_counter.ex index b95517d4b0..c611d9a15c 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/progress_counter.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/progress_counter.ex @@ -23,6 +23,8 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ProgressCounter do * `failure` (*type:* `String.t`, *default:* `nil`) - The number of units that failed in the operation. * `pending` (*type:* `String.t`, *default:* `nil`) - The number of units that are pending in the operation. + * `secondaryFailure` (*type:* `String.t`, *default:* `nil`) - The number of secondary units that failed in the operation. + * `secondarySuccess` (*type:* `String.t`, *default:* `nil`) - The number of secondary units that succeeded in the operation. * `success` (*type:* `String.t`, *default:* `nil`) - The number of units that succeeded in the operation. """ @@ -31,11 +33,15 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.ProgressCounter do @type t :: %__MODULE__{ :failure => String.t() | nil, :pending => String.t() | nil, + :secondaryFailure => String.t() | nil, + :secondarySuccess => String.t() | nil, :success => String.t() | nil } field(:failure) field(:pending) + field(:secondaryFailure) + field(:secondarySuccess) field(:success) end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/pubsub_destination.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/pubsub_destination.ex new file mode 100644 index 0000000000..5aafd810fc --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/pubsub_destination.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.PubsubDestination do + @moduledoc """ + The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the `roles/pubsub.publisher` Cloud IAM role on the Pub/Sub topic. + + ## Attributes + + * `pubsubTopic` (*type:* `String.t`, *default:* `nil`) - The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that Pub/Sub messages are published on. Supplied by the client. The `PubsubMessage` contains the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :pubsubTopic => String.t() | nil + } + + field(:pubsubTopic) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.PubsubDestination do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.PubsubDestination.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.PubsubDestination do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resource_filtering_fields.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resource_filtering_fields.ex new file mode 100644 index 0000000000..179b5a8a25 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resource_filtering_fields.ex @@ -0,0 +1,51 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields do + @moduledoc """ + Filters to select resources that need to be rolled back. + + ## Attributes + + * `metadataFilter` (*type:* `String.t`, *default:* `nil`) - Optional. A filter expression that matches data in the `Resource.meta` element. Supports all filters in [AIP-160](https://google.aip.dev/160) except the "has" (`:`) operator. Supports the following custom functions: * `tag("") = ""` for tag filtering. * `extension_value_ts("") = ` for filtering extensions with a timestamp, where `` is a Unix timestamp. Supports the `>`, `<`, `<=`, `>=`, and `!=` comparison operators. + * `operationIds` (*type:* `list(String.t)`, *default:* `nil`) - Optional. A list of operation IDs to roll back. Only changes made by these operations will be rolled back. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :metadataFilter => String.t() | nil, + :operationIds => list(String.t()) | nil + } + + field(:metadataFilter) + field(:operationIds, type: :list) +end + +defimpl Poison.Decoder, + for: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields.decode(value, options) + end +end + +defimpl Poison.Encoder, + for: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resources_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resources_request.ex new file mode 100644 index 0000000000..5b19a9171d --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resources_request.ex @@ -0,0 +1,72 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesRequest do + @moduledoc """ + Request to roll back resources. + + ## Attributes + + * `changeType` (*type:* `String.t`, *default:* `nil`) - Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. + * `excludeRollbacks` (*type:* `boolean()`, *default:* `nil`) - Optional. Specifies whether to exclude earlier rollbacks. + * `filteringFields` (*type:* `GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields.t`, *default:* `nil`) - Optional. Tag represents fields that HDE needs to identify resources that will be reverted. Parameters for filtering resources + * `force` (*type:* `boolean()`, *default:* `nil`) - Optional. When enabled, changes will be reverted without explicit confirmation + * `inputGcsObject` (*type:* `String.t`, *default:* `nil`) - Optional. Cloud Storage object containing list of {resourceType}/{resourceId} lines, identifying resources to be reverted + * `resultGcsBucket` (*type:* `String.t`, *default:* `nil`) - Required. Bucket to deposit result + * `rollbackTime` (*type:* `DateTime.t`, *default:* `nil`) - Required. Time point to rollback to. + * `type` (*type:* `list(String.t)`, *default:* `nil`) - Optional. If specified, revert only resources of these types + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :changeType => String.t() | nil, + :excludeRollbacks => boolean() | nil, + :filteringFields => + GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields.t() | nil, + :force => boolean() | nil, + :inputGcsObject => String.t() | nil, + :resultGcsBucket => String.t() | nil, + :rollbackTime => DateTime.t() | nil, + :type => list(String.t()) | nil + } + + field(:changeType) + field(:excludeRollbacks) + + field(:filteringFields, + as: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourceFilteringFields + ) + + field(:force) + field(:inputGcsObject) + field(:resultGcsBucket) + field(:rollbackTime, as: DateTime) + field(:type, type: :list) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesRequest do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesRequest.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesRequest do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resources_response.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resources_response.ex new file mode 100644 index 0000000000..746f3416d9 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/rollback_fhir_resources_response.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesResponse do + @moduledoc """ + Final response of rollback FHIR resources request. + + ## Attributes + + * `fhirStore` (*type:* `String.t`, *default:* `nil`) - The name of the FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}". + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :fhirStore => String.t() | nil + } + + field(:fhirStore) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesResponse do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesResponse.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.RollbackFhirResourcesResponse do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/search_resources_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/search_resources_request.ex index c3a1a75161..d9354aaf8f 100644 --- a/clients/health_care/lib/google_api/health_care/v1beta1/model/search_resources_request.ex +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/search_resources_request.ex @@ -21,7 +21,7 @@ defmodule GoogleApi.HealthCare.V1beta1.Model.SearchResourcesRequest do ## Attributes - * `resourceType` (*type:* `String.t`, *default:* `nil`) - The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * `resourceType` (*type:* `String.t`, *default:* `nil`) - Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). """ use GoogleApi.Gax.ModelBase diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/series_metrics.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/series_metrics.ex new file mode 100644 index 0000000000..75ba4f2ae7 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/series_metrics.ex @@ -0,0 +1,55 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics do + @moduledoc """ + SeriesMetrics contains metrics describing a DICOM series. + + ## Attributes + + * `blobStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total blob storage bytes for all instances in the series. + * `instanceCount` (*type:* `String.t`, *default:* `nil`) - Number of instances in the series. + * `series` (*type:* `String.t`, *default:* `nil`) - The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total structured storage bytes for all instances in the series. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSizeBytes => String.t() | nil, + :instanceCount => String.t() | nil, + :series => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil + } + + field(:blobStorageSizeBytes) + field(:instanceCount) + field(:series) + field(:structuredStorageSizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.SeriesMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/set_blob_storage_settings_request.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/set_blob_storage_settings_request.ex new file mode 100644 index 0000000000..b5baabed56 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/set_blob_storage_settings_request.ex @@ -0,0 +1,50 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsRequest do + @moduledoc """ + Request message for `SetBlobStorageSettings` method. + + ## Attributes + + * `blobStorageSettings` (*type:* `GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings.t`, *default:* `nil`) - The blob storage settings to update for the specified resources. Only fields listed in `update_mask` are applied. + * `filterConfig` (*type:* `GoogleApi.HealthCare.V1beta1.Model.DicomFilterConfig.t`, *default:* `nil`) - Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSettings => + GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings.t() | nil, + :filterConfig => GoogleApi.HealthCare.V1beta1.Model.DicomFilterConfig.t() | nil + } + + field(:blobStorageSettings, as: GoogleApi.HealthCare.V1beta1.Model.BlobStorageSettings) + field(:filterConfig, as: GoogleApi.HealthCare.V1beta1.Model.DicomFilterConfig) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsRequest do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsRequest.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsRequest do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/set_blob_storage_settings_response.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/set_blob_storage_settings_response.ex new file mode 100644 index 0000000000..a42fecd253 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/set_blob_storage_settings_response.ex @@ -0,0 +1,41 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsResponse do + @moduledoc """ + Returns additional info in regards to a completed set blob storage settings API. + + ## Attributes + + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{} +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsResponse do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsResponse.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.SetBlobStorageSettingsResponse do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/storage_info.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/storage_info.ex new file mode 100644 index 0000000000..4c7ac5f93c --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/storage_info.ex @@ -0,0 +1,53 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.StorageInfo do + @moduledoc """ + StorageInfo encapsulates all the storage info of a resource. + + ## Attributes + + * `blobStorageInfo` (*type:* `GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo.t`, *default:* `nil`) - Info about the data stored in blob storage for the resource. + * `referencedResource` (*type:* `String.t`, *default:* `nil`) - The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicom_store_id}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}` + * `structuredStorageInfo` (*type:* `GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo.t`, *default:* `nil`) - Info about the data stored in structured storage for the resource. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageInfo => GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo.t() | nil, + :referencedResource => String.t() | nil, + :structuredStorageInfo => + GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo.t() | nil + } + + field(:blobStorageInfo, as: GoogleApi.HealthCare.V1beta1.Model.BlobStorageInfo) + field(:referencedResource) + field(:structuredStorageInfo, as: GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.StorageInfo do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.StorageInfo.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.StorageInfo do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/structured_storage_info.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/structured_storage_info.ex new file mode 100644 index 0000000000..d68645108a --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/structured_storage_info.ex @@ -0,0 +1,46 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo do + @moduledoc """ + StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource. + + ## Attributes + + * `sizeBytes` (*type:* `String.t`, *default:* `nil`) - Size in bytes of data stored in structured storage. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :sizeBytes => String.t() | nil + } + + field(:sizeBytes) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.StructuredStorageInfo do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/study_metrics.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/study_metrics.ex new file mode 100644 index 0000000000..9506e9e9d2 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/study_metrics.ex @@ -0,0 +1,58 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.StudyMetrics do + @moduledoc """ + StudyMetrics contains metrics describing a DICOM study. + + ## Attributes + + * `blobStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total blob storage bytes for all instances in the study. + * `instanceCount` (*type:* `String.t`, *default:* `nil`) - Number of instances in the study. + * `seriesCount` (*type:* `String.t`, *default:* `nil`) - Number of series in the study. + * `structuredStorageSizeBytes` (*type:* `String.t`, *default:* `nil`) - Total structured storage bytes for all instances in the study. + * `study` (*type:* `String.t`, *default:* `nil`) - The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :blobStorageSizeBytes => String.t() | nil, + :instanceCount => String.t() | nil, + :seriesCount => String.t() | nil, + :structuredStorageSizeBytes => String.t() | nil, + :study => String.t() | nil + } + + field(:blobStorageSizeBytes) + field(:instanceCount) + field(:seriesCount) + field(:structuredStorageSizeBytes) + field(:study) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.StudyMetrics do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.StudyMetrics.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.StudyMetrics do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end diff --git a/clients/health_care/lib/google_api/health_care/v1beta1/model/time_range.ex b/clients/health_care/lib/google_api/health_care/v1beta1/model/time_range.ex new file mode 100644 index 0000000000..db5270bfa3 --- /dev/null +++ b/clients/health_care/lib/google_api/health_care/v1beta1/model/time_range.ex @@ -0,0 +1,49 @@ +# Copyright 2019 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# NOTE: This file is auto generated by the elixir code generator program. +# Do not edit this file manually. + +defmodule GoogleApi.HealthCare.V1beta1.Model.TimeRange do + @moduledoc """ + Apply consents given by patients whose most recent consent changes are in the time range. Note that after identifying these patients, the server applies all Consent resources given by those patients, not just the Consent resources within the timestamp in the range. + + ## Attributes + + * `end` (*type:* `String.t`, *default:* `nil`) - Optional. The latest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the time when ApplyConsents was called. + * `start` (*type:* `String.t`, *default:* `nil`) - Optional. The earliest consent change time, in format YYYY-MM-DDThh:mm:ss.sss+zz:zz If not specified, the system uses the FHIR store creation time. + """ + + use GoogleApi.Gax.ModelBase + + @type t :: %__MODULE__{ + :end => String.t() | nil, + :start => String.t() | nil + } + + field(:end) + field(:start) +end + +defimpl Poison.Decoder, for: GoogleApi.HealthCare.V1beta1.Model.TimeRange do + def decode(value, options) do + GoogleApi.HealthCare.V1beta1.Model.TimeRange.decode(value, options) + end +end + +defimpl Poison.Encoder, for: GoogleApi.HealthCare.V1beta1.Model.TimeRange do + def encode(value, options) do + GoogleApi.Gax.ModelBase.encode(value, options) + end +end