diff --git a/generated/google/apis/androidmanagement_v1.rb b/generated/google/apis/androidmanagement_v1.rb index 7302e35cf..f5754d309 100644 --- a/generated/google/apis/androidmanagement_v1.rb +++ b/generated/google/apis/androidmanagement_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/android/management module AndroidmanagementV1 VERSION = 'V1' - REVISION = '20190501' + REVISION = '20190506' # Manage Android devices and apps for your customers AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement' diff --git a/generated/google/apis/androidmanagement_v1/classes.rb b/generated/google/apis/androidmanagement_v1/classes.rb index be156ab30..ccf3727cf 100644 --- a/generated/google/apis/androidmanagement_v1/classes.rb +++ b/generated/google/apis/androidmanagement_v1/classes.rb @@ -1794,8 +1794,8 @@ module Google attr_accessor :metadata # 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 - # have the format of operations/some/unique/name. + # originally returns it. If you use the default HTTP mapping, the name should be + # a resource name ending with operations/`unique_id`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/binaryauthorization_v1beta1.rb b/generated/google/apis/binaryauthorization_v1beta1.rb index 0f64b6710..dfdd2293f 100644 --- a/generated/google/apis/binaryauthorization_v1beta1.rb +++ b/generated/google/apis/binaryauthorization_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/binary-authorization/ module BinaryauthorizationV1beta1 VERSION = 'V1beta1' - REVISION = '20190412' + REVISION = '20190511' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/binaryauthorization_v1beta1/service.rb b/generated/google/apis/binaryauthorization_v1beta1/service.rb index 920cea483..513b6de3b 100644 --- a/generated/google/apis/binaryauthorization_v1beta1/service.rb +++ b/generated/google/apis/binaryauthorization_v1beta1/service.rb @@ -48,6 +48,10 @@ module Google @batch_path = 'batch' end + # A policy specifies the attestors that must attest to + # a container image, before the project is allowed to deploy that + # image. There is at most one policy per project. All image admission + # requests are permitted if a project has no policy. # Gets the policy for this project. Returns a default # policy if the project does not have one. # @param [String] name diff --git a/generated/google/apis/cloudprivatecatalog_v1beta1.rb b/generated/google/apis/cloudprivatecatalog_v1beta1.rb index 239657276..8c93abe8f 100644 --- a/generated/google/apis/cloudprivatecatalog_v1beta1.rb +++ b/generated/google/apis/cloudprivatecatalog_v1beta1.rb @@ -23,10 +23,10 @@ module Google # Enable cloud users to discover enterprise catalogs and products in their # organizations. # - # @see https://sites.google.com/corp/google.com/cloudprivatecatalog + # @see https://cloud.google.com/private-catalog/ module CloudprivatecatalogV1beta1 VERSION = 'V1beta1' - REVISION = '20190304' + REVISION = '20190511' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb b/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb index 8df463453..4a562e08a 100644 --- a/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb +++ b/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb @@ -31,7 +31,7 @@ module Google # Cloudprivatecatalog = Google::Apis::CloudprivatecatalogV1beta1 # Alias the module # service = Cloudprivatecatalog::CloudPrivateCatalogService.new # - # @see https://sites.google.com/corp/google.com/cloudprivatecatalog + # @see https://cloud.google.com/private-catalog/ class CloudPrivateCatalogService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb b/generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb index ea24256c9..7d5e4de31 100644 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb +++ b/generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb @@ -23,10 +23,10 @@ module Google # Enables cloud users to manage and share enterprise catalogs intheir # organizations. # - # @see https://sites.google.com/corp/google.com/cloudprivatecatalog + # @see https://cloud.google.com/private-catalog/ module CloudprivatecatalogproducerV1beta1 VERSION = 'V1beta1' - REVISION = '20190413' + REVISION = '20190511' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb b/generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb index b1240c2a4..8cd435f1b 100644 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb +++ b/generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb @@ -1039,7 +1039,7 @@ module Google # 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 have the format of `operations/some/unique/name`. + # `name` should be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb b/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb index 164a61cbc..89d8c0ff2 100644 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb +++ b/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb @@ -31,7 +31,7 @@ module Google # Cloudprivatecatalogproducer = Google::Apis::CloudprivatecatalogproducerV1beta1 # Alias the module # service = Cloudprivatecatalogproducer::CloudPrivateCatalogProducerService.new # - # @see https://sites.google.com/corp/google.com/cloudprivatecatalog + # @see https://cloud.google.com/private-catalog/ class CloudPrivateCatalogProducerService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, diff --git a/generated/google/apis/container_v1beta1.rb b/generated/google/apis/container_v1beta1.rb index 384309f28..6bd1401c2 100644 --- a/generated/google/apis/container_v1beta1.rb +++ b/generated/google/apis/container_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1beta1 VERSION = 'V1beta1' - REVISION = '20190418' + REVISION = '20190423' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1beta1/classes.rb b/generated/google/apis/container_v1beta1/classes.rb index 84c43363d..4a4186e2c 100644 --- a/generated/google/apis/container_v1beta1/classes.rb +++ b/generated/google/apis/container_v1beta1/classes.rb @@ -598,7 +598,8 @@ module Google # [Output only] The size of the address space on each node for hosting # containers. This is provisioned from within the `container_ipv4_cidr` - # range. + # range. This field will only be set when cluster is in route-based network + # mode. # Corresponds to the JSON property `nodeIpv4CidrSize` # @return [Fixnum] attr_accessor :node_ipv4_cidr_size @@ -688,6 +689,12 @@ module Google # @return [Google::Apis::ContainerV1beta1::VerticalPodAutoscaling] attr_accessor :vertical_pod_autoscaling + # Configuration for the use of Kubernetes Service Accounts in GCP IAM + # policies. + # Corresponds to the JSON property `workloadIdentityConfig` + # @return [Google::Apis::ContainerV1beta1::WorkloadIdentityConfig] + attr_accessor :workload_identity_config + # [Output only] The name of the Google Compute Engine # [zone](/compute/docs/zones#available) in which the cluster # resides. @@ -752,6 +759,7 @@ module Google @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @tpu_ipv4_cidr_block = args[:tpu_ipv4_cidr_block] if args.key?(:tpu_ipv4_cidr_block) @vertical_pod_autoscaling = args[:vertical_pod_autoscaling] if args.key?(:vertical_pod_autoscaling) + @workload_identity_config = args[:workload_identity_config] if args.key?(:workload_identity_config) @zone = args[:zone] if args.key?(:zone) end end @@ -893,9 +901,9 @@ module Google attr_accessor :desired_node_pool_autoscaling # The node pool to be upgraded. This field is mandatory if - # "desired_node_version", "desired_image_family" or - # "desired_node_pool_autoscaling" is specified and there is more than one - # node pool on the cluster. + # "desired_node_version", "desired_image_family", + # "desired_node_pool_autoscaling", or "desired_workload_metadata_config" + # is specified and there is more than one node pool on the cluster. # Corresponds to the JSON property `desiredNodePoolId` # @return [String] attr_accessor :desired_node_pool_id @@ -918,6 +926,11 @@ module Google # @return [Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig] attr_accessor :desired_pod_security_policy_config + # Configuration options for private clusters. + # Corresponds to the JSON property `desiredPrivateClusterConfig` + # @return [Google::Apis::ContainerV1beta1::PrivateClusterConfig] + attr_accessor :desired_private_cluster_config + # Configuration for exporting cluster resource usages. # Corresponds to the JSON property `desiredResourceUsageExportConfig` # @return [Google::Apis::ContainerV1beta1::ResourceUsageExportConfig] @@ -930,6 +943,12 @@ module Google # @return [Google::Apis::ContainerV1beta1::VerticalPodAutoscaling] attr_accessor :desired_vertical_pod_autoscaling + # Configuration for the use of Kubernetes Service Accounts in GCP IAM + # policies. + # Corresponds to the JSON property `desiredWorkloadIdentityConfig` + # @return [Google::Apis::ContainerV1beta1::WorkloadIdentityConfig] + attr_accessor :desired_workload_identity_config + def initialize(**args) update!(**args) end @@ -951,8 +970,10 @@ module Google @desired_node_pool_id = args[:desired_node_pool_id] if args.key?(:desired_node_pool_id) @desired_node_version = args[:desired_node_version] if args.key?(:desired_node_version) @desired_pod_security_policy_config = args[:desired_pod_security_policy_config] if args.key?(:desired_pod_security_policy_config) + @desired_private_cluster_config = args[:desired_private_cluster_config] if args.key?(:desired_private_cluster_config) @desired_resource_usage_export_config = args[:desired_resource_usage_export_config] if args.key?(:desired_resource_usage_export_config) @desired_vertical_pod_autoscaling = args[:desired_vertical_pod_autoscaling] if args.key?(:desired_vertical_pod_autoscaling) + @desired_workload_identity_config = args[:desired_workload_identity_config] if args.key?(:desired_workload_identity_config) end end @@ -2611,6 +2632,12 @@ module Google class PrivateClusterConfig include Google::Apis::Core::Hashable + # Whether to enable route sharing over the network peering. + # Corresponds to the JSON property `enablePeeringRouteSharing` + # @return [Boolean] + attr_accessor :enable_peering_route_sharing + alias_method :enable_peering_route_sharing?, :enable_peering_route_sharing + # Whether the master's internal IP address is used as the cluster endpoint. # Corresponds to the JSON property `enablePrivateEndpoint` # @return [Boolean] @@ -2649,6 +2676,7 @@ module Google # Update properties of this object def update!(**args) + @enable_peering_route_sharing = args[:enable_peering_route_sharing] if args.key?(:enable_peering_route_sharing) @enable_private_endpoint = args[:enable_private_endpoint] if args.key?(:enable_private_endpoint) @enable_private_nodes = args[:enable_private_nodes] if args.key?(:enable_private_nodes) @master_ipv4_cidr_block = args[:master_ipv4_cidr_block] if args.key?(:master_ipv4_cidr_block) @@ -3856,6 +3884,26 @@ module Google end end + # Configuration for the use of Kubernetes Service Accounts in GCP IAM + # policies. + class WorkloadIdentityConfig + include Google::Apis::Core::Hashable + + # IAM Identity Namespace to attach all Kubernetes Service Accounts to. + # Corresponds to the JSON property `identityNamespace` + # @return [String] + attr_accessor :identity_namespace + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @identity_namespace = args[:identity_namespace] if args.key?(:identity_namespace) + end + end + # WorkloadMetadataConfig defines the metadata configuration to expose to # workloads on the node pool. class WorkloadMetadataConfig diff --git a/generated/google/apis/container_v1beta1/representations.rb b/generated/google/apis/container_v1beta1/representations.rb index 66b61678e..8fe8c7efb 100644 --- a/generated/google/apis/container_v1beta1/representations.rb +++ b/generated/google/apis/container_v1beta1/representations.rb @@ -496,6 +496,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WorkloadIdentityConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class WorkloadMetadataConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -671,6 +677,8 @@ module Google property :tpu_ipv4_cidr_block, as: 'tpuIpv4CidrBlock' property :vertical_pod_autoscaling, as: 'verticalPodAutoscaling', class: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling, decorator: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling::Representation + property :workload_identity_config, as: 'workloadIdentityConfig', class: Google::Apis::ContainerV1beta1::WorkloadIdentityConfig, decorator: Google::Apis::ContainerV1beta1::WorkloadIdentityConfig::Representation + property :zone, as: 'zone' end end @@ -712,10 +720,14 @@ module Google property :desired_node_version, as: 'desiredNodeVersion' property :desired_pod_security_policy_config, as: 'desiredPodSecurityPolicyConfig', class: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig, decorator: Google::Apis::ContainerV1beta1::PodSecurityPolicyConfig::Representation + property :desired_private_cluster_config, as: 'desiredPrivateClusterConfig', class: Google::Apis::ContainerV1beta1::PrivateClusterConfig, decorator: Google::Apis::ContainerV1beta1::PrivateClusterConfig::Representation + property :desired_resource_usage_export_config, as: 'desiredResourceUsageExportConfig', class: Google::Apis::ContainerV1beta1::ResourceUsageExportConfig, decorator: Google::Apis::ContainerV1beta1::ResourceUsageExportConfig::Representation property :desired_vertical_pod_autoscaling, as: 'desiredVerticalPodAutoscaling', class: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling, decorator: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling::Representation + property :desired_workload_identity_config, as: 'desiredWorkloadIdentityConfig', class: Google::Apis::ContainerV1beta1::WorkloadIdentityConfig, decorator: Google::Apis::ContainerV1beta1::WorkloadIdentityConfig::Representation + end end @@ -1128,6 +1140,7 @@ module Google class PrivateClusterConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + property :enable_peering_route_sharing, as: 'enablePeeringRouteSharing' property :enable_private_endpoint, as: 'enablePrivateEndpoint' property :enable_private_nodes, as: 'enablePrivateNodes' property :master_ipv4_cidr_block, as: 'masterIpv4CidrBlock' @@ -1409,6 +1422,13 @@ module Google end end + class WorkloadIdentityConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :identity_namespace, as: 'identityNamespace' + end + end + class WorkloadMetadataConfig # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index cbcfd7ab5..23854ea64 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow-enterprise/ module DialogflowV2 VERSION = 'V2' - REVISION = '20190506' + REVISION = '20190514' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 0e7ede5bf..07eaa40f6 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -882,8 +882,8 @@ module Google # @return [String] attr_accessor :action - # Optional. The list of platforms for which the first response will be - # taken from among the messages assigned to the DEFAULT_PLATFORM. + # Optional. The list of platforms for which the first responses will be + # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms @@ -2948,8 +2948,8 @@ module Google # @return [String] attr_accessor :action - # Optional. The list of platforms for which the first response will be - # taken from among the messages assigned to the DEFAULT_PLATFORM. + # Optional. The list of platforms for which the first responses will be + # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms diff --git a/generated/google/apis/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index 3463a6d78..4a9efff83 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20190422' + REVISION = '20190511' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dlp_v2/classes.rb b/generated/google/apis/dlp_v2/classes.rb index 42a7d4786..68bd46d51 100644 --- a/generated/google/apis/dlp_v2/classes.rb +++ b/generated/google/apis/dlp_v2/classes.rb @@ -33,7 +33,10 @@ module Google # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2JobNotificationEmails] attr_accessor :job_notification_emails - # Publish the results of a DlpJob to a pub sub channel. + # Publish a message into given Pub/Sub topic when DlpJob has completed. The + # message contains a single field, `DlpJobName`, which is equal to the + # finished job's + # [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). # Compatible with: Inspect, Risk # Corresponds to the JSON property `pubSub` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2PublishToPubSub] @@ -4360,7 +4363,10 @@ module Google end end - # Publish the results of a DlpJob to a pub sub channel. + # Publish a message into given Pub/Sub topic when DlpJob has completed. The + # message contains a single field, `DlpJobName`, which is equal to the + # finished job's + # [`DlpJob.name`](/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob). # Compatible with: Inspect, Risk class GooglePrivacyDlpV2PublishToPubSub include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dlp_v2/service.rb b/generated/google/apis/dlp_v2/service.rb index 534e1b4da..4e15cb0ac 100644 --- a/generated/google/apis/dlp_v2/service.rb +++ b/generated/google/apis/dlp_v2/service.rb @@ -1135,13 +1135,18 @@ module Google # - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED # - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY # - `trigger_name` - The resource name of the trigger that created job. + # - 'end_time` - Corresponds to time the job finished. + # - 'start_time` - Corresponds to time the job finished. # * Supported fields for risk analysis jobs: # - `state` - RUNNING|CANCELED|FINISHED|FAILED + # - 'end_time` - Corresponds to time the job finished. + # - 'start_time` - Corresponds to time the job finished. # * The operator must be `=` or `!=`. # Examples: # * inspected_storage = cloud_storage AND state = done # * inspected_storage = cloud_storage OR inspected_storage = bigquery # * inspected_storage = cloud_storage AND (state = done OR state = canceled) + # * end_time > \"2017-12-12T00:00:00+00:00\" # The length of this field should be no more than 500 characters. # @param [String] order_by # Optional comma separated list of fields to order by, diff --git a/generated/google/apis/healthcare_v1alpha2.rb b/generated/google/apis/healthcare_v1alpha2.rb new file mode 100644 index 000000000..afcc072be --- /dev/null +++ b/generated/google/apis/healthcare_v1alpha2.rb @@ -0,0 +1,34 @@ +# Copyright 2015 Google Inc. +# +# 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. + +require 'google/apis/healthcare_v1alpha2/service.rb' +require 'google/apis/healthcare_v1alpha2/classes.rb' +require 'google/apis/healthcare_v1alpha2/representations.rb' + +module Google + module Apis + # Cloud Healthcare API + # + # Manage, store, and access healthcare data in Google Cloud Platform. + # + # @see https://cloud.google.com/healthcare + module HealthcareV1alpha2 + VERSION = 'V1alpha2' + REVISION = '20190503' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/healthcare_v1alpha2/classes.rb b/generated/google/apis/healthcare_v1alpha2/classes.rb new file mode 100644 index 000000000..8a50aebc4 --- /dev/null +++ b/generated/google/apis/healthcare_v1alpha2/classes.rb @@ -0,0 +1,2849 @@ +# Copyright 2015 Google Inc. +# +# 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. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module HealthcareV1alpha2 + + # An annotation record. + class Annotation + include Google::Apis::Core::Hashable + + # AnnotationSource holds the source information of the annotation. + # Corresponds to the JSON property `annotationSource` + # @return [Google::Apis::HealthcareV1alpha2::AnnotationSource] + attr_accessor :annotation_source + + # Image annotation. + # Corresponds to the JSON property `imageAnnotation` + # @return [Google::Apis::HealthcareV1alpha2::ImageAnnotation] + attr_accessor :image_annotation + + # Output only. Resource name of the Annotation, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # annotationStores/`annotation_store_id`/annotations/`annotation_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Resource level annotation. + # Corresponds to the JSON property `resourceAnnotation` + # @return [Google::Apis::HealthcareV1alpha2::ResourceAnnotation] + attr_accessor :resource_annotation + + # A TextAnnotation specifies a text range that includes sensitive information. + # Corresponds to the JSON property `textAnnotation` + # @return [Google::Apis::HealthcareV1alpha2::SensitiveTextAnnotation] + attr_accessor :text_annotation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotation_source = args[:annotation_source] if args.key?(:annotation_source) + @image_annotation = args[:image_annotation] if args.key?(:image_annotation) + @name = args[:name] if args.key?(:name) + @resource_annotation = args[:resource_annotation] if args.key?(:resource_annotation) + @text_annotation = args[:text_annotation] if args.key?(:text_annotation) + end + end + + # AnnotationSource holds the source information of the annotation. + class AnnotationSource + include Google::Apis::Core::Hashable + + # Cloud Healthcare API resource. + # Corresponds to the JSON property `cloudHealthcareSource` + # @return [Google::Apis::HealthcareV1alpha2::CloudHealthcareSource] + attr_accessor :cloud_healthcare_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cloud_healthcare_source = args[:cloud_healthcare_source] if args.key?(:cloud_healthcare_source) + end + end + + # An Annotation store that can store annotation resources such as + # labels and tags for text, image and audio. + class AnnotationStore + include Google::Apis::Core::Hashable + + # 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 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. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the Annotation store, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # annotationStores/`annotation_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + end + end + + # Specifies the audit configuration for a service. + # The configuration determines which permission types are logged, and what + # identities, if any, are exempted from logging. + # An AuditConfig must have one or more AuditLogConfigs. + # If there are AuditConfigs for both `allServices` and a specific service, + # the union of the two AuditConfigs is used for that service: the log_types + # specified in each AuditConfig are enabled, and the exempted_members in each + # AuditLogConfig are exempted. + # Example Policy with multiple AuditConfigs: + # ` + # "audit_configs": [ + # ` + # "service": "allServices" + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # "exempted_members": [ + # "user:foo@gmail.com" + # ] + # `, + # ` + # "log_type": "DATA_WRITE", + # `, + # ` + # "log_type": "ADMIN_READ", + # ` + # ] + # `, + # ` + # "service": "fooservice.googleapis.com" + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # `, + # ` + # "log_type": "DATA_WRITE", + # "exempted_members": [ + # "user:bar@gmail.com" + # ] + # ` + # ] + # ` + # ] + # ` + # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ + # logging. It also exempts foo@gmail.com from DATA_READ logging, and + # bar@gmail.com from DATA_WRITE logging. + class AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + attr_accessor :audit_log_configs + + # Specifies a service that will be enabled for audit logging. + # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + # `allServices` is a special value that covers all services. + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs) + @service = args[:service] if args.key?(:service) + end + end + + # Provides the configuration for logging a type of permissions. + # Example: + # ` + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # "exempted_members": [ + # "user:foo@gmail.com" + # ] + # `, + # ` + # "log_type": "DATA_WRITE", + # ` + # ] + # ` + # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + # foo@gmail.com from DATA_READ logging. + class AuditLogConfig + include Google::Apis::Core::Hashable + + # Specifies the identities that do not cause logging for this type of + # permission. + # Follows the same format of Binding.members. + # Corresponds to the JSON property `exemptedMembers` + # @return [Array] + attr_accessor :exempted_members + + # The log type that this config enables. + # Corresponds to the JSON property `logType` + # @return [String] + attr_accessor :log_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @log_type = args[:log_type] if args.key?(:log_type) + end + end + + # Associates `members` with a `role`. + class Binding + include Google::Apis::Core::Hashable + + # Represents an expression text. Example: + # title: "User account presence" + # description: "Determines whether the request has a user account" + # expression: "size(request.user) > 0" + # Corresponds to the JSON property `condition` + # @return [Google::Apis::HealthcareV1alpha2::Expr] + attr_accessor :condition + + # Specifies the identities requesting access for a Cloud Platform resource. + # `members` can have the following values: + # * `allUsers`: A special identifier that represents anyone who is + # on the internet; with or without a Google account. + # * `allAuthenticatedUsers`: A special identifier that represents anyone + # who is authenticated with a Google account or a service account. + # * `user:`emailid``: An email address that represents a specific Google + # account. For example, `alice@gmail.com` . + # * `serviceAccount:`emailid``: An email address that represents a service + # account. For example, `my-other-app@appspot.gserviceaccount.com`. + # * `group:`emailid``: An email address that represents a Google group. + # For example, `admins@example.com`. + # * `domain:`domain``: The G Suite domain (primary) that represents all the + # users of that domain. For example, `google.com` or `example.com`. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # Role that is assigned to `members`. + # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @condition = args[:condition] if args.key?(:condition) + @members = args[:members] if args.key?(:members) + @role = args[:role] if args.key?(:role) + end + end + + # A bounding polygon for the detected image annotation. + class BoundingPoly + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `label` + # @return [String] + attr_accessor :label + + # + # Corresponds to the JSON property `vertices` + # @return [Array] + attr_accessor :vertices + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label = args[:label] if args.key?(:label) + @vertices = args[:vertices] if args.key?(:vertices) + end + end + + # Mask a string by replacing its characters with a fixed character. + class CharacterMaskConfig + include Google::Apis::Core::Hashable + + # Character to mask the sensitive values. If not supplied, defaults to "*". + # Corresponds to the JSON property `maskingCharacter` + # @return [String] + attr_accessor :masking_character + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @masking_character = args[:masking_character] if args.key?(:masking_character) + end + end + + # Cloud Healthcare API resource. + class CloudHealthcareSource + include Google::Apis::Core::Hashable + + # Full path of a Cloud Healthcare API resource. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # Creates a new message. + class CreateMessageRequest + include Google::Apis::Core::Hashable + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + # Corresponds to the JSON property `message` + # @return [Google::Apis::HealthcareV1alpha2::Message] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @message = args[:message] if args.key?(:message) + end + end + + # Pseudonymization method that generates surrogates via cryptographic hashing. + # Uses SHA-256. + # Outputs a base64-encoded representation of the hashed output + # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + class CryptoHashConfig + include Google::Apis::Core::Hashable + + # An AES 128/192/256 bit key. Causes the hash to be computed based on this + # key. A default key is generated for each DeidentifyDataset operation and is + # used wherever crypto_key is not specified. + # Corresponds to the JSON property `cryptoKey` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :crypto_key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crypto_key = args[:crypto_key] if args.key?(:crypto_key) + end + end + + # A message representing a health dataset. + # A health dataset represents a collection of healthcare data pertaining to one + # or more patients. This may include multiple modalities of healthcare data, + # such as electronic medical records or medical imaging data. + class Dataset + include Google::Apis::Core::Hashable + + # Output only. Resource name of the dataset, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # 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 (e.g., HL7 messages) where no + # explicit timezone is specified. + # Corresponds to the JSON property `timeZone` + # @return [String] + attr_accessor :time_zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @time_zone = args[:time_zone] if args.key?(:time_zone) + end + end + + # Shift a date forward or backward in time by a random amount which is + # consistent for a given patient and crypto key combination. + class DateShiftConfig + include Google::Apis::Core::Hashable + + # 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 + # DeidentifyDataset operation and is used wherever crypto_key is not + # specified. + # Corresponds to the JSON property `cryptoKey` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :crypto_key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crypto_key = args[:crypto_key] if args.key?(:crypto_key) + end + end + + # Configures de-id options specific to different types of content. + # Each submessage customizes the handling of an + # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + # applied in a nested manner at runtime. + class DeidentifyConfig + include Google::Apis::Core::Hashable + + # Specifies the parameters needed for de-identification of DICOM stores. + # Corresponds to the JSON property `dicom` + # @return [Google::Apis::HealthcareV1alpha2::DicomConfig] + attr_accessor :dicom + + # Specifies how de-identification of a FHIR store should be handled. + # Corresponds to the JSON property `fhir` + # @return [Google::Apis::HealthcareV1alpha2::FhirConfig] + attr_accessor :fhir + + # Specifies how de-identification of image pixel should be handled. + # Corresponds to the JSON property `image` + # @return [Google::Apis::HealthcareV1alpha2::ImageConfig] + attr_accessor :image + + # Configures de-identification of text wherever it is found in the + # source_dataset. + # Corresponds to the JSON property `text` + # @return [Google::Apis::HealthcareV1alpha2::TextConfig] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dicom = args[:dicom] if args.key?(:dicom) + @fhir = args[:fhir] if args.key?(:fhir) + @image = args[:image] if args.key?(:image) + @text = args[:text] if args.key?(:text) + end + end + + # Redacts identifying information from the specified dataset. + class DeidentifyDatasetRequest + include Google::Apis::Core::Hashable + + # Configures de-id options specific to different types of content. + # Each submessage customizes the handling of an + # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + # applied in a nested manner at runtime. + # Corresponds to the JSON property `config` + # @return [Google::Apis::HealthcareV1alpha2::DeidentifyConfig] + attr_accessor :config + + # The name of the dataset resource to create and write the redacted data to + # (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``). + # * The destination dataset must not exist. + # * The destination dataset must be in the same project as the source + # dataset. De-identifying data across multiple projects is not supported. + # Corresponds to the JSON property `destinationDataset` + # @return [String] + attr_accessor :destination_dataset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config = args[:config] if args.key?(:config) + @destination_dataset = args[:destination_dataset] if args.key?(:destination_dataset) + end + end + + # Contains the status of the Deidentify operation. + class DeidentifyErrorDetails + include Google::Apis::Core::Hashable + + # Number of resources failed to process. + # Corresponds to the JSON property `failureResourceCount` + # @return [Fixnum] + attr_accessor :failure_resource_count + + # Number of stores failed to process. + # Corresponds to the JSON property `failureStoreCount` + # @return [Fixnum] + attr_accessor :failure_store_count + + # Number of resources successfully processed. + # Corresponds to the JSON property `successResourceCount` + # @return [Fixnum] + attr_accessor :success_resource_count + + # Number of stores successfully processed. + # Corresponds to the JSON property `successStoreCount` + # @return [Fixnum] + attr_accessor :success_store_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @failure_resource_count = args[:failure_resource_count] if args.key?(:failure_resource_count) + @failure_store_count = args[:failure_store_count] if args.key?(:failure_store_count) + @success_resource_count = args[:success_resource_count] if args.key?(:success_resource_count) + @success_store_count = args[:success_store_count] if args.key?(:success_store_count) + end + end + + # Contains a detailed summary of the Deidentify operation. + class DeidentifySummary + include Google::Apis::Core::Hashable + + # Number of resources successfully processed. + # Corresponds to the JSON property `successResourceCount` + # @return [Fixnum] + attr_accessor :success_resource_count + + # Number of stores successfully processed. + # Corresponds to the JSON property `successStoreCount` + # @return [Fixnum] + attr_accessor :success_store_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @success_resource_count = args[:success_resource_count] if args.key?(:success_resource_count) + @success_store_count = args[:success_store_count] if args.key?(:success_store_count) + end + end + + # Contains multiple sensitive information findings for each resource slice. + class Detail + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `findings` + # @return [Array] + attr_accessor :findings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @findings = args[:findings] if args.key?(:findings) + end + end + + # Specifies the parameters needed for de-identification of DICOM stores. + class DicomConfig + include Google::Apis::Core::Hashable + + # Tag filtering profile that determines which tags to keep/remove. + # Corresponds to the JSON property `filterProfile` + # @return [String] + attr_accessor :filter_profile + + # List of tags to be filtered. + # Corresponds to the JSON property `keepList` + # @return [Google::Apis::HealthcareV1alpha2::TagFilterList] + attr_accessor :keep_list + + # List of tags to be filtered. + # Corresponds to the JSON property `removeList` + # @return [Google::Apis::HealthcareV1alpha2::TagFilterList] + attr_accessor :remove_list + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter_profile = args[:filter_profile] if args.key?(:filter_profile) + @keep_list = args[:keep_list] if args.key?(:keep_list) + @remove_list = args[:remove_list] if args.key?(:remove_list) + end + end + + # Represents a DICOM store. + class DicomStore + include Google::Apis::Core::Hashable + + # 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. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the DICOM store, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specifies where notifications should be sent upon changes to a data store. + # Corresponds to the JSON property `notificationConfig` + # @return [Google::Apis::HealthcareV1alpha2::NotificationConfig] + attr_accessor :notification_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @notification_config = args[:notification_config] if args.key?(:notification_config) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Structure to describe the error encountered during batch operation on one + # resource. This is used both for sample errors in operation response, and + # for format of errors in error reports. + class ErrorDetail + include Google::Apis::Core::Hashable + + # The `Status` type defines a logical error model that is suitable for + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error + # message, and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::HealthcareV1alpha2::Status] + attr_accessor :error + + # The identifier of the resource. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error = args[:error] if args.key?(:error) + @resource = args[:resource] if args.key?(:resource) + end + end + + # Exports data from the specified DICOM store. + # If a given resource (e.g., a DICOM object with the same SOPInstance UID) + # already exists in the output, it is overwritten with the version + # in the source dataset. + # Exported DICOM data will persist when the DICOM store from which it was + # exported is deleted. + class ExportDicomDataRequest + include Google::Apis::Core::Hashable + + # The BigQuery table where the output should be written. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomBigQueryDestination] + attr_accessor :bigquery_destination + + # The Cloud Storage location where the output should be written, and the export + # configuration. + # Corresponds to the JSON property `gcsDestination` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomGcsDestination] + attr_accessor :gcs_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + end + end + + # Request to export resources. + class ExportResourcesRequest + include Google::Apis::Core::Hashable + + # The configuration for exporting to BigQuery. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirBigQueryDestination] + attr_accessor :bigquery_destination + + # The configuration for exporting to Cloud Storage. + # Corresponds to the JSON property `gcsDestination` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsDestination] + attr_accessor :gcs_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + end + end + + # Represents an expression text. Example: + # title: "User account presence" + # description: "Determines whether the request has a user account" + # expression: "size(request.user) > 0" + class Expr + include Google::Apis::Core::Hashable + + # An optional description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Textual representation of an expression in + # Common Expression Language syntax. + # The application context of the containing message determines which + # well-known feature set of CEL is supported. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # An optional string indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # An optional title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @expression = args[:expression] if args.key?(:expression) + @location = args[:location] if args.key?(:location) + @title = args[:title] if args.key?(:title) + end + end + + # Specifies how de-identification of a FHIR store should be handled. + class FhirConfig + include Google::Apis::Core::Hashable + + # Specifies FHIR paths to match and how to transform them. Any field that + # is not matched by a FieldMetadata will be passed through to the output + # dataset unmodified. All extensions are removed in the output. + # Corresponds to the JSON property `fieldMetadataList` + # @return [Array] + attr_accessor :field_metadata_list + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field_metadata_list = args[:field_metadata_list] if args.key?(:field_metadata_list) + end + end + + # Represents a FHIR store. + class FhirStore + include Google::Apis::Core::Hashable + + # 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 will enforce referential + # integrity and fail the requests that will result in inconsistent state in + # the FHIR store. + # When this field is set to true, the API will skip referential integrity + # check. Consequently, operations that rely on references, such as + # GetPatientEverything, will not return all the results if broken references + # exist. + # Corresponds to the JSON property `disableReferentialIntegrity` + # @return [Boolean] + attr_accessor :disable_referential_integrity + alias_method :disable_referential_integrity?, :disable_referential_integrity + + # 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 will + # 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 will be kept. The server will send + # back errors for attempts to read the historical versions. + # Corresponds to the JSON property `disableResourceVersioning` + # @return [Boolean] + attr_accessor :disable_resource_versioning + alias_method :disable_resource_versioning?, :disable_resource_versioning + + # Whether to allow the bulk import API to accept history bundles and directly + # insert historical resource versions into the FHIR store. Importing resource + # histories creates resource interactions that appear to have occurred in the + # past, which clients may not want to allow. If set to false, history bundles + # within an import will fail with an error. + # Corresponds to the JSON property `enableHistoryImport` + # @return [Boolean] + attr_accessor :enable_history_import + alias_method :enable_history_import?, :enable_history_import + + # 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 + # will return errors. Please treat the audit logs with appropriate levels of + # care if client-specified resource IDs contain sensitive data such as + # patient identifiers, those IDs will be part of the FHIR resource path + # recorded in Cloud audit logs and Cloud Pub/Sub notifications. + # Corresponds to the JSON property `enableUpdateCreate` + # @return [Boolean] + attr_accessor :enable_update_create + alias_method :enable_update_create?, :enable_update_create + + # 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. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the FHIR store, of the form + # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specifies where notifications should be sent upon changes to a data store. + # Corresponds to the JSON property `notificationConfig` + # @return [Google::Apis::HealthcareV1alpha2::NotificationConfig] + attr_accessor :notification_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disable_referential_integrity = args[:disable_referential_integrity] if args.key?(:disable_referential_integrity) + @disable_resource_versioning = args[:disable_resource_versioning] if args.key?(:disable_resource_versioning) + @enable_history_import = args[:enable_history_import] if args.key?(:enable_history_import) + @enable_update_create = args[:enable_update_create] if args.key?(:enable_update_create) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @notification_config = args[:notification_config] if args.key?(:notification_config) + end + end + + # Specifies FHIR paths to match, and how to handle de-identification of + # matching fields. + class FieldMetadata + include Google::Apis::Core::Hashable + + # Deidentify action for one field. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # List of paths to FHIR fields to be redacted. Each path is a + # period-separated list where each component is either a field name or + # FHIR type name, for example: Patient, HumanName. + # For "choice" types (those defined in the FHIR spec with the form: + # field[x]) we use two separate components. e.g. "deceasedAge.unit" is + # matched by "Deceased.Age.unit". + # Supported types are: AdministrativeGenderCode, Code, Date, DateTime, + # Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid, + # String, Uri, Uuid, Xhtml. + # Corresponds to the JSON property `paths` + # @return [Array] + attr_accessor :paths + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @paths = args[:paths] if args.key?(:paths) + end + end + + # + class Finding + include Google::Apis::Core::Hashable + + # Zero-based ending index of the found text, exclusively. + # Corresponds to the JSON property `end` + # @return [Fixnum] + attr_accessor :end + + # The type of information stored in this text range (e.g. HumanName, + # BirthDate, Address, etc.) + # Corresponds to the JSON property `infoType` + # @return [String] + attr_accessor :info_type + + # Zero-based starting index of the found text, inclusively. + # Corresponds to the JSON property `start` + # @return [Fixnum] + attr_accessor :start + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end = args[:end] if args.key?(:end) + @info_type = args[:info_type] if args.key?(:info_type) + @start = args[:start] if args.key?(:start) + end + end + + # Request message for `GetIamPolicy` method. + class GetIamPolicyRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The BigQuery table where the output should be written. + class GoogleCloudHealthcareV1alpha2DicomBigQueryDestination + include Google::Apis::Core::Hashable + + # If the destination table already exists and this flag is `TRUE`, the table + # will be overwritten by the contents of the DICOM store. If the flag is not + # set and the destination table already exists, the export call returns an + # error. + # Corresponds to the JSON property `force` + # @return [Boolean] + attr_accessor :force + alias_method :force?, :force + + # BigQuery URI to a table, up to 2000 characters long, in the format + # `bq://projectId.bqDatasetId.tableId` + # Corresponds to the JSON property `tableUri` + # @return [String] + attr_accessor :table_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @force = args[:force] if args.key?(:force) + @table_uri = args[:table_uri] if args.key?(:table_uri) + end + end + + # The Cloud Storage location where the output should be written, and the export + # configuration. + class GoogleCloudHealthcareV1alpha2DicomGcsDestination + include Google::Apis::Core::Hashable + + # MIME types supported by DICOM spec. + # Each file will be written in the following format: + # `.../`study_id`/`series_id`/`instance_id`[/`frame_number`].`extension`` + # The frame_number component will exist only for multi-frame instances. + # Refer to the DICOM conformance statement for permissible MIME types: + # https://cloud.google.com/healthcare/docs/dicom#wado-rs + # The following extensions will be used for output files: + # application/dicom -> .dcm + # image/jpeg -> .jpg + # image/png -> .png + # If unspecified, the instances will be exported in their original + # DICOM format. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The Cloud Storage destination to export to. + # URI for a Cloud Storage directory where result files should be written (in + # the format `gs://`bucket-id`/`path/to/destination/dir``). If there is no + # trailing slash, the service will append one when composing the object path. + # The user is responsible for creating the Cloud Storage bucket referenced in + # `uri_prefix`. + # Corresponds to the JSON property `uriPrefix` + # @return [String] + attr_accessor :uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix) + end + end + + # Specifies the configuration for importing data from Cloud Storage. + class GoogleCloudHealthcareV1alpha2DicomGcsSource + include Google::Apis::Core::Hashable + + # Points to a Cloud Storage URI containing file(s) with + # content only. The URI must be in the following format: + # `gs://`bucket_id`/`object_id``. The URI can include wildcards in + # `object_id` and thus identify multiple files. Supported wildcards: + # '*' to match 0 or more non-separator characters + # '**' to match 0 or more characters (including separators). Must be used at + # the end of a path and with no other wildcards in the + # path. Can also be used with a file extension (such as .dcm), which + # imports all files with the extension in the specified directory and + # its sub-directories. For example, + # `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm + # extensions in `my-directory/` and its sub-directories. + # '?' to match 1 character + # All other URI formats are invalid. + # Files matching the wildcard are expected to contain content only, no + # metadata. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri = args[:uri] if args.key?(:uri) + end + end + + # The configuration for exporting to BigQuery. + class GoogleCloudHealthcareV1alpha2FhirBigQueryDestination + include Google::Apis::Core::Hashable + + # BigQuery URI to a dataset, up to 2000 characters long, in the format + # `bq://projectId.bqDatasetId` + # Corresponds to the JSON property `datasetUri` + # @return [String] + attr_accessor :dataset_uri + + # Configuration for the FHIR BigQuery schema. Determines how the server + # generates the schema. + # Corresponds to the JSON property `schemaConfig` + # @return [Google::Apis::HealthcareV1alpha2::SchemaConfig] + attr_accessor :schema_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dataset_uri = args[:dataset_uri] if args.key?(:dataset_uri) + @schema_config = args[:schema_config] if args.key?(:schema_config) + end + end + + # Final response of exporting resources. + # This structure will be included in the + # response to describe the detailed + # outcome. It will only be included when the operation finishes. + class GoogleCloudHealthcareV1alpha2FhirRestExportResourcesResponse + include Google::Apis::Core::Hashable + + # The name of the FHIR store where resources have been exported, in the + # format + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # Corresponds to the JSON property `fhirStore` + # @return [String] + attr_accessor :fhir_store + + # The total number of resources exported from the requested FHIR store. + # Corresponds to the JSON property `resourceCount` + # @return [Fixnum] + attr_accessor :resource_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fhir_store = args[:fhir_store] if args.key?(:fhir_store) + @resource_count = args[:resource_count] if args.key?(:resource_count) + end + end + + # The configuration for exporting to Cloud Storage. + class GoogleCloudHealthcareV1alpha2FhirRestGcsDestination + include Google::Apis::Core::Hashable + + # URI for a Cloud Storage directory where result files should be written (in + # the format `gs://`bucket-id`/`path/to/destination/dir``). If there is no + # trailing slash, the service will append one when composing the object path. + # The user is responsible for creating the Cloud Storage bucket referenced in + # `uri_prefix`. + # Corresponds to the JSON property `uriPrefix` + # @return [String] + attr_accessor :uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix) + end + end + + # Specifies the Cloud Storage destination where errors will be recorded. + class GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination + include Google::Apis::Core::Hashable + + # URI for a Cloud Storage directory to which error report files should be + # written (in the format `gs://`bucket-id`/`path/to/destination/dir``). If + # there is no trailing slash, the service will append one when composing the + # object path. The user is responsible for creating the Cloud Storage bucket + # referenced in `uri_prefix`. + # Corresponds to the JSON property `uriPrefix` + # @return [String] + attr_accessor :uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix) + end + end + + # Specifies the configuration for importing data from Cloud Storage. + class GoogleCloudHealthcareV1alpha2FhirRestGcsSource + include Google::Apis::Core::Hashable + + # Points to a Cloud Storage URI containing file(s) to import. + # The URI must be in the following format: `gs://`bucket_id`/`object_id``. + # The URI can include wildcards in `object_id` and thus identify multiple + # files. Supported wildcards: + # * `*` to match 0 or more non-separator characters + # * `**` to match 0 or more characters (including separators). Must be used + # at the end of a path and with no other wildcards in the + # path. Can also be used with a file extension (such as .ndjson), which + # imports all files with the extension in the specified directory and + # its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` + # imports all files with `.ndjson` extensions in `my-directory/` and its + # sub-directories. + # * `?` to match 1 character + # Files matching the wildcard are expected to contain content only, no + # metadata. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri = args[:uri] if args.key?(:uri) + end + end + + # Error response of importing resources. + # This structure will be included in the + # error details to describe the + # detailed error. It will only be included when the operation finishes with + # some failure. + class GoogleCloudHealthcareV1alpha2FhirRestImportResourcesErrorDetails + include Google::Apis::Core::Hashable + + # The number of resources that had errors. + # Corresponds to the JSON property `errorCount` + # @return [Fixnum] + attr_accessor :error_count + + # The name of the FHIR store where resources have been imported, in the + # format + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # Corresponds to the JSON property `fhirStore` + # @return [String] + attr_accessor :fhir_store + + # The total number of resources included in the source data. This is the sum + # of the success and error counts. + # Corresponds to the JSON property `inputSize` + # @return [Fixnum] + attr_accessor :input_size + + # The number of resources that have been imported. + # Corresponds to the JSON property `successCount` + # @return [Fixnum] + attr_accessor :success_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error_count = args[:error_count] if args.key?(:error_count) + @fhir_store = args[:fhir_store] if args.key?(:fhir_store) + @input_size = args[:input_size] if args.key?(:input_size) + @success_count = args[:success_count] if args.key?(:success_count) + end + end + + # Final response of importing resources. + # This structure will be included in the + # response to describe the detailed + # outcome. It will only be included when the operation finishes successfully. + class GoogleCloudHealthcareV1alpha2FhirRestImportResourcesResponse + include Google::Apis::Core::Hashable + + # The name of the FHIR store where the resources have been imported, in the + # format + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # Corresponds to the JSON property `fhirStore` + # @return [String] + attr_accessor :fhir_store + + # The total number of resources included in the source data. + # Corresponds to the JSON property `inputSize` + # @return [Fixnum] + attr_accessor :input_size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fhir_store = args[:fhir_store] if args.key?(:fhir_store) + @input_size = args[:input_size] if args.key?(:input_size) + end + end + + # Represents an HL7v2 store. + class Hl7V2Store + include Google::Apis::Core::Hashable + + # 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. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the HL7v2 store, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specifies where notifications should be sent upon changes to a data store. + # Corresponds to the JSON property `notificationConfig` + # @return [Google::Apis::HealthcareV1alpha2::NotificationConfig] + attr_accessor :notification_config + + # The configuration for the parser. It determines how the server parses the + # messages. + # Corresponds to the JSON property `parserConfig` + # @return [Google::Apis::HealthcareV1alpha2::ParserConfig] + attr_accessor :parser_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @notification_config = args[:notification_config] if args.key?(:notification_config) + @parser_config = args[:parser_config] if args.key?(:parser_config) + end + end + + # Message that represents an arbitrary HTTP body. It should only be used for + # payload formats that can't be represented as JSON, such as raw binary or + # an HTML page. + # This message can be used both in streaming and non-streaming API methods in + # the request as well as the response. + # It can be used as a top-level request field, which is convenient if one + # wants to extract parameters from either the URL or HTTP template into the + # request fields and also want access to the raw HTTP body. + # Example: + # message GetResourceRequest ` + # // A unique request id. + # string request_id = 1; + # // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; + # ` + # service ResourceService ` + # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); + # rpc UpdateResource(google.api.HttpBody) returns + # (google.protobuf.Empty); + # ` + # Example with streaming methods: + # service CaldavService ` + # rpc GetCalendar(stream google.api.HttpBody) + # returns (stream google.api.HttpBody); + # rpc UpdateCalendar(stream google.api.HttpBody) + # returns (stream google.api.HttpBody); + # ` + # Use of this type only changes how the request and response bodies are + # handled, all other features will continue to work unchanged. + class HttpBody + include Google::Apis::Core::Hashable + + # The HTTP Content-Type header value specifying the content type of the body. + # Corresponds to the JSON property `contentType` + # @return [String] + attr_accessor :content_type + + # The HTTP request/response body as raw binary. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # Application specific response metadata. Must be set in the first response + # for streaming APIs. + # Corresponds to the JSON property `extensions` + # @return [Array>] + attr_accessor :extensions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_type = args[:content_type] if args.key?(:content_type) + @data = args[:data] if args.key?(:data) + @extensions = args[:extensions] if args.key?(:extensions) + end + end + + # Image annotation. + class ImageAnnotation + include Google::Apis::Core::Hashable + + # The list of polygons outlining the sensitive regions in the image. + # Corresponds to the JSON property `boundingPolys` + # @return [Array] + attr_accessor :bounding_polys + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_polys = args[:bounding_polys] if args.key?(:bounding_polys) + end + end + + # Specifies how de-identification of image pixel should be handled. + class ImageConfig + include Google::Apis::Core::Hashable + + # Determines how to redact text from image. + # Corresponds to the JSON property `textRedactionMode` + # @return [String] + attr_accessor :text_redaction_mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text_redaction_mode = args[:text_redaction_mode] if args.key?(:text_redaction_mode) + end + end + + # Returns the errors encountered during DICOM store import. + class ImportDicomDataErrorDetails + include Google::Apis::Core::Hashable + + # Deprecated. Use only for debugging purposes. + # Contains sample errors encountered in imports of individual resources + # (for example, a Cloud Storage object). + # Corresponds to the JSON property `sampleErrors` + # @return [Array] + attr_accessor :sample_errors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sample_errors = args[:sample_errors] if args.key?(:sample_errors) + end + end + + # Imports data into the specified DICOM store. + # Returns an error if any of the files to import are not DICOM files. This + # API will accept duplicate DICOM instances, by simply ignoring the newly + # pushed instance (it will not overwrite). + class ImportDicomDataRequest + include Google::Apis::Core::Hashable + + # Specifies the configuration for importing data from Cloud Storage. + # Corresponds to the JSON property `gcsSource` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomGcsSource] + attr_accessor :gcs_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_source = args[:gcs_source] if args.key?(:gcs_source) + end + end + + # Request to import resources. + class ImportResourcesRequest + include Google::Apis::Core::Hashable + + # The content structure in the source location. The default is + # BUNDLE. + # Corresponds to the JSON property `contentStructure` + # @return [String] + attr_accessor :content_structure + + # Specifies the Cloud Storage destination where errors will be recorded. + # Corresponds to the JSON property `gcsErrorDestination` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination] + attr_accessor :gcs_error_destination + + # Specifies the configuration for importing data from Cloud Storage. + # Corresponds to the JSON property `gcsSource` + # @return [Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsSource] + attr_accessor :gcs_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_structure = args[:content_structure] if args.key?(:content_structure) + @gcs_error_destination = args[:gcs_error_destination] if args.key?(:gcs_error_destination) + @gcs_source = args[:gcs_source] if args.key?(:gcs_source) + end + end + + # A transformation to apply to text that is identified as a specific + # info_type. + class InfoTypeTransformation + include Google::Apis::Core::Hashable + + # Mask a string by replacing its characters with a fixed character. + # Corresponds to the JSON property `characterMaskConfig` + # @return [Google::Apis::HealthcareV1alpha2::CharacterMaskConfig] + attr_accessor :character_mask_config + + # Pseudonymization method that generates surrogates via cryptographic hashing. + # Uses SHA-256. + # Outputs a base64-encoded representation of the hashed output + # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + # Corresponds to the JSON property `cryptoHashConfig` + # @return [Google::Apis::HealthcareV1alpha2::CryptoHashConfig] + attr_accessor :crypto_hash_config + + # Shift a date forward or backward in time by a random amount which is + # consistent for a given patient and crypto key combination. + # Corresponds to the JSON property `dateShiftConfig` + # @return [Google::Apis::HealthcareV1alpha2::DateShiftConfig] + attr_accessor :date_shift_config + + # InfoTypes to apply this transformation to. If this is not specified, the + # transformation applies to any info_type. + # Corresponds to the JSON property `infoTypes` + # @return [Array] + attr_accessor :info_types + + # Define how to redact sensitive values. Default behaviour is erase, + # e.g. "My name is Jake." becomes "My name is ." + # Corresponds to the JSON property `redactConfig` + # @return [Google::Apis::HealthcareV1alpha2::RedactConfig] + attr_accessor :redact_config + + # When using the INSPECT_AND_TRANSFORM action, each match is replaced with + # the name of the info_type. For example, "My name is Jake" becomes "My name is + # [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. + # Corresponds to the JSON property `replaceWithInfoTypeConfig` + # @return [Google::Apis::HealthcareV1alpha2::ReplaceWithInfoTypeConfig] + attr_accessor :replace_with_info_type_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @character_mask_config = args[:character_mask_config] if args.key?(:character_mask_config) + @crypto_hash_config = args[:crypto_hash_config] if args.key?(:crypto_hash_config) + @date_shift_config = args[:date_shift_config] if args.key?(:date_shift_config) + @info_types = args[:info_types] if args.key?(:info_types) + @redact_config = args[:redact_config] if args.key?(:redact_config) + @replace_with_info_type_config = args[:replace_with_info_type_config] if args.key?(:replace_with_info_type_config) + end + end + + # Ingests a message into the specified HL7v2 store. + class IngestMessageRequest + include Google::Apis::Core::Hashable + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + # Corresponds to the JSON property `message` + # @return [Google::Apis::HealthcareV1alpha2::Message] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @message = args[:message] if args.key?(:message) + end + end + + # Acknowledges that a message has been ingested into the specified + # HL7v2 store. + class IngestMessageResponse + include Google::Apis::Core::Hashable + + # HL7v2 ACK message. + # Corresponds to the JSON property `hl7Ack` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :hl7_ack + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + # Corresponds to the JSON property `message` + # @return [Google::Apis::HealthcareV1alpha2::Message] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hl7_ack = args[:hl7_ack] if args.key?(:hl7_ack) + @message = args[:message] if args.key?(:message) + end + end + + # Lists the Annotation stores + # in the given dataset. + class ListAnnotationStoresResponse + include Google::Apis::Core::Hashable + + # The returned Annotation stores. Won't be more Annotation stores than the + # value of page_size in the request. + # Corresponds to the JSON property `annotationStores` + # @return [Array] + attr_accessor :annotation_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotation_stores = args[:annotation_stores] if args.key?(:annotation_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the Annotations in the specified + # Annotation store. + class ListAnnotationsResponse + include Google::Apis::Core::Hashable + + # The returned Annotations names. Won't be more values than the value of + # page_size in the request. + # Corresponds to the JSON property `annotations` + # @return [Array] + attr_accessor :annotations + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotations = args[:annotations] if args.key?(:annotations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the available datasets. + class ListDatasetsResponse + include Google::Apis::Core::Hashable + + # The first page of datasets. + # Corresponds to the JSON property `datasets` + # @return [Array] + attr_accessor :datasets + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @datasets = args[:datasets] if args.key?(:datasets) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the DICOM stores in the given dataset. + class ListDicomStoresResponse + include Google::Apis::Core::Hashable + + # The returned DICOM stores. Won't be more DICOM stores than the value of + # page_size in the request. + # Corresponds to the JSON property `dicomStores` + # @return [Array] + attr_accessor :dicom_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dicom_stores = args[:dicom_stores] if args.key?(:dicom_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the FHIR stores in the given dataset. + class ListFhirStoresResponse + include Google::Apis::Core::Hashable + + # The returned FHIR stores. Won't be more FHIR stores than the value of + # page_size in the request. + # Corresponds to the JSON property `fhirStores` + # @return [Array] + attr_accessor :fhir_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fhir_stores = args[:fhir_stores] if args.key?(:fhir_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the HL7v2 stores in the given dataset. + class ListHl7V2StoresResponse + include Google::Apis::Core::Hashable + + # The returned HL7v2 stores. Won't be more HL7v2 stores than the value of + # page_size in the request. + # Corresponds to the JSON property `hl7V2Stores` + # @return [Array] + attr_accessor :hl7_v2_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hl7_v2_stores = args[:hl7_v2_stores] if args.key?(:hl7_v2_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Locations.ListLocations. + class ListLocationsResponse + include Google::Apis::Core::Hashable + + # A list of locations that matches the specified filter in the request. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @locations = args[:locations] if args.key?(:locations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the messages in the specified HL7v2 store. + class ListMessagesResponse + include Google::Apis::Core::Hashable + + # The returned message names. Won't be more values than the value of + # page_size in the request. + # Corresponds to the JSON property `messages` + # @return [Array] + attr_accessor :messages + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @messages = args[:messages] if args.key?(:messages) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Operations.ListOperations. + class ListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # A resource that represents Google Cloud Platform location. + class Location + include Google::Apis::Core::Hashable + + # The friendly name for this location, typically a nearby city name. + # For example, "Tokyo". + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Cross-service attributes for the location. For example + # `"cloud.googleapis.com/region": "us-east1"` + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The canonical id for this location. For example: `"us-east1"`. + # Corresponds to the JSON property `locationId` + # @return [String] + attr_accessor :location_id + + # Service-specific metadata. For example the available capacity at the given + # location. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Resource name for the location, which may vary between implementations. + # For example: `"projects/example-project/locations/us-east1"` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @location_id = args[:location_id] if args.key?(:location_id) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + end + end + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + class Message + include Google::Apis::Core::Hashable + + # The datetime when the message was created. Set by the server. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Raw message bytes. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # 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. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The message type and trigger event for this message. MSH-9. + # Corresponds to the JSON property `messageType` + # @return [String] + attr_accessor :message_type + + # Resource name of the Message, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/ + # messages/`message_id``. + # Assigned by the server. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The content of a HL7v2 message in a structured format. + # Corresponds to the JSON property `parsedData` + # @return [Google::Apis::HealthcareV1alpha2::ParsedData] + attr_accessor :parsed_data + + # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this + # message. + # Corresponds to the JSON property `patientIds` + # @return [Array] + attr_accessor :patient_ids + + # The hospital that this message came from. MSH-4. + # Corresponds to the JSON property `sendFacility` + # @return [String] + attr_accessor :send_facility + + # The datetime the sending application sent this message. MSH-7. + # Corresponds to the JSON property `sendTime` + # @return [String] + attr_accessor :send_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @data = args[:data] if args.key?(:data) + @labels = args[:labels] if args.key?(:labels) + @message_type = args[:message_type] if args.key?(:message_type) + @name = args[:name] if args.key?(:name) + @parsed_data = args[:parsed_data] if args.key?(:parsed_data) + @patient_ids = args[:patient_ids] if args.key?(:patient_ids) + @send_facility = args[:send_facility] if args.key?(:send_facility) + @send_time = args[:send_time] if args.key?(:send_time) + end + end + + # Specifies where notifications should be sent upon changes to a data store. + class NotificationConfig + include Google::Apis::Core::Hashable + + # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that + # notifications of changes are published on. Supplied by the client. + # PubsubMessage.Data will contain 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@system.gserviceaccount.com must have + # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate + # permissions will cause the calls that send notifications to fail. + # Corresponds to the JSON property `pubsubTopic` + # @return [String] + attr_accessor :pubsub_topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error + # message, and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::HealthcareV1alpha2::Status] + attr_accessor :error + + # 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. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # 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``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # 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`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # OperationMetadata provides information about the operation execution. + # Returned in the long-running operation's metadata field. + class OperationMetadata + include Google::Apis::Core::Hashable + + # The name of the API method that initiated the operation. + # Corresponds to the JSON property `apiMethodName` + # @return [String] + attr_accessor :api_method_name + + # ProgressCounter provides counters to describe an operation's progress. + # Corresponds to the JSON property `counter` + # @return [Google::Apis::HealthcareV1alpha2::ProgressCounter] + attr_accessor :counter + + # The time at which the operation was created by the API. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The time at which execution was completed. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_method_name = args[:api_method_name] if args.key?(:api_method_name) + @counter = args[:counter] if args.key?(:counter) + @create_time = args[:create_time] if args.key?(:create_time) + @end_time = args[:end_time] if args.key?(:end_time) + end + end + + # The content of a HL7v2 message in a structured format. + class ParsedData + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `segments` + # @return [Array] + attr_accessor :segments + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @segments = args[:segments] if args.key?(:segments) + end + end + + # The configuration for the parser. It determines how the server parses the + # messages. + class ParserConfig + include Google::Apis::Core::Hashable + + # Determines whether messages with no header are allowed. + # Corresponds to the JSON property `allowNullHeader` + # @return [Boolean] + attr_accessor :allow_null_header + alias_method :allow_null_header?, :allow_null_header + + # Byte(s) to be used as the segment terminator. If this is unset, '\r' will + # be used as segment terminator. + # Corresponds to the JSON property `segmentTerminator` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :segment_terminator + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_null_header = args[:allow_null_header] if args.key?(:allow_null_header) + @segment_terminator = args[:segment_terminator] if args.key?(:segment_terminator) + end + end + + # A patient identifier and associated type. + class PatientId + include Google::Apis::Core::Hashable + + # ID type, e.g. MRN or NHS. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The patient's unique identifier. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + end + end + + # Defines an Identity and Access Management (IAM) policy. It is used to + # specify access control policies for Cloud Platform resources. + # A `Policy` consists of a list of `bindings`. A `binding` binds a list of + # `members` to a `role`, where the members can be user accounts, Google groups, + # Google domains, and service accounts. A `role` is a named list of permissions + # defined by IAM. + # **JSON Example** + # ` + # "bindings": [ + # ` + # "role": "roles/owner", + # "members": [ + # "user:mike@example.com", + # "group:admins@example.com", + # "domain:google.com", + # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # ] + # `, + # ` + # "role": "roles/viewer", + # "members": ["user:sean@example.com"] + # ` + # ] + # ` + # **YAML Example** + # bindings: + # - members: + # - user:mike@example.com + # - group:admins@example.com + # - domain:google.com + # - serviceAccount:my-other-app@appspot.gserviceaccount.com + # role: roles/owner + # - members: + # - user:sean@example.com + # role: roles/viewer + # For a description of IAM and its features, see the + # [IAM developer's guide](https://cloud.google.com/iam/docs). + class Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + attr_accessor :audit_configs + + # Associates a list of `members` to a `role`. + # `bindings` with no members will result in an error. + # Corresponds to the JSON property `bindings` + # @return [Array] + attr_accessor :bindings + + # `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of a policy from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the + # read-modify-write cycle to perform policy updates in order to avoid race + # conditions: An `etag` is returned in the response to `getIamPolicy`, and + # systems are expected to put that etag in the request to `setIamPolicy` to + # ensure that their change will be applied to the same version of the policy. + # If no `etag` is provided in the call to `setIamPolicy`, then the existing + # policy is overwritten blindly. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # Deprecated. + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_configs = args[:audit_configs] if args.key?(:audit_configs) + @bindings = args[:bindings] if args.key?(:bindings) + @etag = args[:etag] if args.key?(:etag) + @version = args[:version] if args.key?(:version) + end + end + + # ProgressCounter provides counters to describe an operation's progress. + class ProgressCounter + include Google::Apis::Core::Hashable + + # The number of units that failed in the operation. + # Corresponds to the JSON property `failure` + # @return [Fixnum] + attr_accessor :failure + + # The number of units that are pending in the operation. + # Corresponds to the JSON property `pending` + # @return [Fixnum] + attr_accessor :pending + + # The number of units that succeeded in the operation. + # Corresponds to the JSON property `success` + # @return [Fixnum] + attr_accessor :success + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @failure = args[:failure] if args.key?(:failure) + @pending = args[:pending] if args.key?(:pending) + @success = args[:success] if args.key?(:success) + end + end + + # Define how to redact sensitive values. Default behaviour is erase, + # e.g. "My name is Jake." becomes "My name is ." + class RedactConfig + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # When using the INSPECT_AND_TRANSFORM action, each match is replaced with + # the name of the info_type. For example, "My name is Jake" becomes "My name is + # [PERSON_NAME]." The TRANSFORM action is equivalent to redacting. + class ReplaceWithInfoTypeConfig + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Resource level annotation. + class ResourceAnnotation + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `label` + # @return [String] + attr_accessor :label + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label = args[:label] if args.key?(:label) + end + end + + # Configuration for the FHIR BigQuery schema. Determines how the server + # generates the schema. + class SchemaConfig + include Google::Apis::Core::Hashable + + # 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. + # Corresponds to the JSON property `recursiveStructureDepth` + # @return [Fixnum] + attr_accessor :recursive_structure_depth + + # Specifies the output schema type. If unspecified, the default is + # `LOSSLESS`. + # Corresponds to the JSON property `schemaType` + # @return [String] + attr_accessor :schema_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @recursive_structure_depth = args[:recursive_structure_depth] if args.key?(:recursive_structure_depth) + @schema_type = args[:schema_type] if args.key?(:schema_type) + end + end + + # Request to search the resources in the specified FHIR store. + class SearchResourcesRequest + include Google::Apis::Core::Hashable + + # The FHIR resource type to search, such as Patient or Observation. For a + # complete list, see the [FHIR Resource + # Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_type = args[:resource_type] if args.key?(:resource_type) + end + end + + # A segment in a structured format. + class Segment + include Google::Apis::Core::Hashable + + # A mapping from the positional location to the value. + # The key string uses zero-based indexes separated by dots to identify + # Fields, components and sub-components. A bracket notation is also used to + # identify different instances of a repeated field. + # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? + # Examples of (key, value) pairs: + # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". + # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value + # "bar". + # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, + # has the value "baz". + # Corresponds to the JSON property `fields` + # @return [Hash] + attr_accessor :fields + + # A string that indicates the type of segment, e.g., EVN, PID. + # Corresponds to the JSON property `segmentId` + # @return [String] + attr_accessor :segment_id + + # Set ID for segments that can be in a set. This can be empty if it is + # missing or it is not applicable. + # Corresponds to the JSON property `setId` + # @return [String] + attr_accessor :set_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @segment_id = args[:segment_id] if args.key?(:segment_id) + @set_id = args[:set_id] if args.key?(:set_id) + end + end + + # A TextAnnotation specifies a text range that includes sensitive information. + class SensitiveTextAnnotation + include Google::Apis::Core::Hashable + + # Maps from a resource slice (e.g. FHIR resource field path) to a set of + # sensitive text findings. For example, + # Appointment.Narrative text1 --> `findings_1, findings_2, findings_3` + # Corresponds to the JSON property `details` + # @return [Hash] + attr_accessor :details + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @details = args[:details] if args.key?(:details) + end + end + + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + include Google::Apis::Core::Hashable + + # Defines an Identity and Access Management (IAM) policy. It is used to + # specify access control policies for Cloud Platform resources. + # A `Policy` consists of a list of `bindings`. A `binding` binds a list of + # `members` to a `role`, where the members can be user accounts, Google groups, + # Google domains, and service accounts. A `role` is a named list of permissions + # defined by IAM. + # **JSON Example** + # ` + # "bindings": [ + # ` + # "role": "roles/owner", + # "members": [ + # "user:mike@example.com", + # "group:admins@example.com", + # "domain:google.com", + # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # ] + # `, + # ` + # "role": "roles/viewer", + # "members": ["user:sean@example.com"] + # ` + # ] + # ` + # **YAML Example** + # bindings: + # - members: + # - user:mike@example.com + # - group:admins@example.com + # - domain:google.com + # - serviceAccount:my-other-app@appspot.gserviceaccount.com + # role: roles/owner + # - members: + # - user:sean@example.com + # role: roles/viewer + # For a description of IAM and its features, see the + # [IAM developer's guide](https://cloud.google.com/iam/docs). + # Corresponds to the JSON property `policy` + # @return [Google::Apis::HealthcareV1alpha2::Policy] + attr_accessor :policy + + # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only + # the fields in the mask will be modified. If no mask is provided, the + # following default mask is used: + # paths: "bindings, etag" + # This field is only used by Cloud IAM. + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy = args[:policy] if args.key?(:policy) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # The `Status` type defines a logical error model that is suitable for + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error + # message, and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # List of tags to be filtered. + class TagFilterList + include Google::Apis::Core::Hashable + + # Tags to be filtered. Tags must be DICOM Data Elements, File Meta + # Elements, or Directory Structuring Elements, as defined at: + # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. + # They may be provided by "Keyword" or "Tag". For example "PatientID", + # "00100010". + # Corresponds to the JSON property `tags` + # @return [Array] + attr_accessor :tags + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tags = args[:tags] if args.key?(:tags) + end + end + + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest + include Google::Apis::Core::Hashable + + # The set of permissions to check for the `resource`. Permissions with + # wildcards (such as '*' or 'storage.*') are not allowed. For more + # information see + # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # Response message for `TestIamPermissions` method. + class TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # + class TextConfig + include Google::Apis::Core::Hashable + + # Experimental de-identification config to use. For internal use only. + # If not specified, it is ignored and standard DLP is used. + # Corresponds to the JSON property `experimentalConfig` + # @return [String] + attr_accessor :experimental_config + + # The transformations to apply to the detected data. + # Corresponds to the JSON property `transformations` + # @return [Array] + attr_accessor :transformations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @experimental_config = args[:experimental_config] if args.key?(:experimental_config) + @transformations = args[:transformations] if args.key?(:transformations) + end + end + + # A 2D coordinate in an image. The origin is the top-left. + class Vertex + include Google::Apis::Core::Hashable + + # X coordinate. + # Corresponds to the JSON property `x` + # @return [Float] + attr_accessor :x + + # Y coordinate. + # Corresponds to the JSON property `y` + # @return [Float] + attr_accessor :y + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @x = args[:x] if args.key?(:x) + @y = args[:y] if args.key?(:y) + end + end + end + end +end diff --git a/generated/google/apis/healthcare_v1alpha2/representations.rb b/generated/google/apis/healthcare_v1alpha2/representations.rb new file mode 100644 index 000000000..4deab27e6 --- /dev/null +++ b/generated/google/apis/healthcare_v1alpha2/representations.rb @@ -0,0 +1,1260 @@ +# Copyright 2015 Google Inc. +# +# 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. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module HealthcareV1alpha2 + + class Annotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AnnotationSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AnnotationStore + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BoundingPoly + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CharacterMaskConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CloudHealthcareSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateMessageRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CryptoHashConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dataset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateShiftConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyDatasetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyErrorDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifySummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Detail + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DicomConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DicomStore + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ErrorDetail + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportDicomDataRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportResourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FhirConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FhirStore + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FieldMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Finding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2DicomBigQueryDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2DicomGcsDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2DicomGcsSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirBigQueryDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirRestExportResourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirRestGcsDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirRestGcsSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirRestImportResourcesErrorDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1alpha2FhirRestImportResourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Hl7V2Store + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HttpBody + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImageAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImageConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportDicomDataErrorDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportDicomDataRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportResourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InfoTypeTransformation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IngestMessageRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IngestMessageResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListAnnotationStoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListAnnotationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDatasetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDicomStoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListFhirStoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListHl7V2StoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListMessagesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Message + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NotificationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ParsedData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ParserConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatientId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProgressCounter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RedactConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReplaceWithInfoTypeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResourceAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SchemaConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchResourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Segment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SensitiveTextAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagFilterList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Vertex + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Annotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :annotation_source, as: 'annotationSource', class: Google::Apis::HealthcareV1alpha2::AnnotationSource, decorator: Google::Apis::HealthcareV1alpha2::AnnotationSource::Representation + + property :image_annotation, as: 'imageAnnotation', class: Google::Apis::HealthcareV1alpha2::ImageAnnotation, decorator: Google::Apis::HealthcareV1alpha2::ImageAnnotation::Representation + + property :name, as: 'name' + property :resource_annotation, as: 'resourceAnnotation', class: Google::Apis::HealthcareV1alpha2::ResourceAnnotation, decorator: Google::Apis::HealthcareV1alpha2::ResourceAnnotation::Representation + + property :text_annotation, as: 'textAnnotation', class: Google::Apis::HealthcareV1alpha2::SensitiveTextAnnotation, decorator: Google::Apis::HealthcareV1alpha2::SensitiveTextAnnotation::Representation + + end + end + + class AnnotationSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cloud_healthcare_source, as: 'cloudHealthcareSource', class: Google::Apis::HealthcareV1alpha2::CloudHealthcareSource, decorator: Google::Apis::HealthcareV1alpha2::CloudHealthcareSource::Representation + + end + end + + class AnnotationStore + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + end + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::HealthcareV1alpha2::AuditLogConfig, decorator: Google::Apis::HealthcareV1alpha2::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::HealthcareV1alpha2::Expr, decorator: Google::Apis::HealthcareV1alpha2::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class BoundingPoly + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :label, as: 'label' + collection :vertices, as: 'vertices', class: Google::Apis::HealthcareV1alpha2::Vertex, decorator: Google::Apis::HealthcareV1alpha2::Vertex::Representation + + end + end + + class CharacterMaskConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :masking_character, as: 'maskingCharacter' + end + end + + class CloudHealthcareSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class CreateMessageRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :message, as: 'message', class: Google::Apis::HealthcareV1alpha2::Message, decorator: Google::Apis::HealthcareV1alpha2::Message::Representation + + end + end + + class CryptoHashConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crypto_key, :base64 => true, as: 'cryptoKey' + end + end + + class Dataset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :time_zone, as: 'timeZone' + end + end + + class DateShiftConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crypto_key, :base64 => true, as: 'cryptoKey' + end + end + + class DeidentifyConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dicom, as: 'dicom', class: Google::Apis::HealthcareV1alpha2::DicomConfig, decorator: Google::Apis::HealthcareV1alpha2::DicomConfig::Representation + + property :fhir, as: 'fhir', class: Google::Apis::HealthcareV1alpha2::FhirConfig, decorator: Google::Apis::HealthcareV1alpha2::FhirConfig::Representation + + property :image, as: 'image', class: Google::Apis::HealthcareV1alpha2::ImageConfig, decorator: Google::Apis::HealthcareV1alpha2::ImageConfig::Representation + + property :text, as: 'text', class: Google::Apis::HealthcareV1alpha2::TextConfig, decorator: Google::Apis::HealthcareV1alpha2::TextConfig::Representation + + end + end + + class DeidentifyDatasetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config, as: 'config', class: Google::Apis::HealthcareV1alpha2::DeidentifyConfig, decorator: Google::Apis::HealthcareV1alpha2::DeidentifyConfig::Representation + + property :destination_dataset, as: 'destinationDataset' + end + end + + class DeidentifyErrorDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :failure_resource_count, :numeric_string => true, as: 'failureResourceCount' + property :failure_store_count, :numeric_string => true, as: 'failureStoreCount' + property :success_resource_count, :numeric_string => true, as: 'successResourceCount' + property :success_store_count, :numeric_string => true, as: 'successStoreCount' + end + end + + class DeidentifySummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :success_resource_count, :numeric_string => true, as: 'successResourceCount' + property :success_store_count, :numeric_string => true, as: 'successStoreCount' + end + end + + class Detail + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :findings, as: 'findings', class: Google::Apis::HealthcareV1alpha2::Finding, decorator: Google::Apis::HealthcareV1alpha2::Finding::Representation + + end + end + + class DicomConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter_profile, as: 'filterProfile' + property :keep_list, as: 'keepList', class: Google::Apis::HealthcareV1alpha2::TagFilterList, decorator: Google::Apis::HealthcareV1alpha2::TagFilterList::Representation + + property :remove_list, as: 'removeList', class: Google::Apis::HealthcareV1alpha2::TagFilterList, decorator: Google::Apis::HealthcareV1alpha2::TagFilterList::Representation + + end + end + + class DicomStore + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1alpha2::NotificationConfig, decorator: Google::Apis::HealthcareV1alpha2::NotificationConfig::Representation + + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ErrorDetail + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :error, as: 'error', class: Google::Apis::HealthcareV1alpha2::Status, decorator: Google::Apis::HealthcareV1alpha2::Status::Representation + + property :resource, as: 'resource' + end + end + + class ExportDicomDataRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomBigQueryDestination, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomBigQueryDestination::Representation + + property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomGcsDestination, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomGcsDestination::Representation + + end + end + + class ExportResourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirBigQueryDestination, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirBigQueryDestination::Representation + + property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsDestination, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsDestination::Representation + + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class FhirConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :field_metadata_list, as: 'fieldMetadataList', class: Google::Apis::HealthcareV1alpha2::FieldMetadata, decorator: Google::Apis::HealthcareV1alpha2::FieldMetadata::Representation + + end + end + + class FhirStore + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disable_referential_integrity, as: 'disableReferentialIntegrity' + property :disable_resource_versioning, as: 'disableResourceVersioning' + property :enable_history_import, as: 'enableHistoryImport' + property :enable_update_create, as: 'enableUpdateCreate' + hash :labels, as: 'labels' + property :name, as: 'name' + property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1alpha2::NotificationConfig, decorator: Google::Apis::HealthcareV1alpha2::NotificationConfig::Representation + + end + end + + class FieldMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + collection :paths, as: 'paths' + end + end + + class Finding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end, :numeric_string => true, as: 'end' + property :info_type, as: 'infoType' + property :start, :numeric_string => true, as: 'start' + end + end + + class GetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudHealthcareV1alpha2DicomBigQueryDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :force, as: 'force' + property :table_uri, as: 'tableUri' + end + end + + class GoogleCloudHealthcareV1alpha2DicomGcsDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :mime_type, as: 'mimeType' + property :uri_prefix, as: 'uriPrefix' + end + end + + class GoogleCloudHealthcareV1alpha2DicomGcsSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudHealthcareV1alpha2FhirBigQueryDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dataset_uri, as: 'datasetUri' + property :schema_config, as: 'schemaConfig', class: Google::Apis::HealthcareV1alpha2::SchemaConfig, decorator: Google::Apis::HealthcareV1alpha2::SchemaConfig::Representation + + end + end + + class GoogleCloudHealthcareV1alpha2FhirRestExportResourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fhir_store, as: 'fhirStore' + property :resource_count, :numeric_string => true, as: 'resourceCount' + end + end + + class GoogleCloudHealthcareV1alpha2FhirRestGcsDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri_prefix, as: 'uriPrefix' + end + end + + class GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri_prefix, as: 'uriPrefix' + end + end + + class GoogleCloudHealthcareV1alpha2FhirRestGcsSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudHealthcareV1alpha2FhirRestImportResourcesErrorDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :error_count, :numeric_string => true, as: 'errorCount' + property :fhir_store, as: 'fhirStore' + property :input_size, :numeric_string => true, as: 'inputSize' + property :success_count, :numeric_string => true, as: 'successCount' + end + end + + class GoogleCloudHealthcareV1alpha2FhirRestImportResourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fhir_store, as: 'fhirStore' + property :input_size, :numeric_string => true, as: 'inputSize' + end + end + + class Hl7V2Store + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1alpha2::NotificationConfig, decorator: Google::Apis::HealthcareV1alpha2::NotificationConfig::Representation + + property :parser_config, as: 'parserConfig', class: Google::Apis::HealthcareV1alpha2::ParserConfig, decorator: Google::Apis::HealthcareV1alpha2::ParserConfig::Representation + + end + end + + class HttpBody + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_type, as: 'contentType' + property :data, :base64 => true, as: 'data' + collection :extensions, as: 'extensions' + end + end + + class ImageAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :bounding_polys, as: 'boundingPolys', class: Google::Apis::HealthcareV1alpha2::BoundingPoly, decorator: Google::Apis::HealthcareV1alpha2::BoundingPoly::Representation + + end + end + + class ImageConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :text_redaction_mode, as: 'textRedactionMode' + end + end + + class ImportDicomDataErrorDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :sample_errors, as: 'sampleErrors', class: Google::Apis::HealthcareV1alpha2::ErrorDetail, decorator: Google::Apis::HealthcareV1alpha2::ErrorDetail::Representation + + end + end + + class ImportDicomDataRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_source, as: 'gcsSource', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomGcsSource, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2DicomGcsSource::Representation + + end + end + + class ImportResourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_structure, as: 'contentStructure' + property :gcs_error_destination, as: 'gcsErrorDestination', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsErrorDestination::Representation + + property :gcs_source, as: 'gcsSource', class: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsSource, decorator: Google::Apis::HealthcareV1alpha2::GoogleCloudHealthcareV1alpha2FhirRestGcsSource::Representation + + end + end + + class InfoTypeTransformation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :character_mask_config, as: 'characterMaskConfig', class: Google::Apis::HealthcareV1alpha2::CharacterMaskConfig, decorator: Google::Apis::HealthcareV1alpha2::CharacterMaskConfig::Representation + + property :crypto_hash_config, as: 'cryptoHashConfig', class: Google::Apis::HealthcareV1alpha2::CryptoHashConfig, decorator: Google::Apis::HealthcareV1alpha2::CryptoHashConfig::Representation + + property :date_shift_config, as: 'dateShiftConfig', class: Google::Apis::HealthcareV1alpha2::DateShiftConfig, decorator: Google::Apis::HealthcareV1alpha2::DateShiftConfig::Representation + + collection :info_types, as: 'infoTypes' + property :redact_config, as: 'redactConfig', class: Google::Apis::HealthcareV1alpha2::RedactConfig, decorator: Google::Apis::HealthcareV1alpha2::RedactConfig::Representation + + property :replace_with_info_type_config, as: 'replaceWithInfoTypeConfig', class: Google::Apis::HealthcareV1alpha2::ReplaceWithInfoTypeConfig, decorator: Google::Apis::HealthcareV1alpha2::ReplaceWithInfoTypeConfig::Representation + + end + end + + class IngestMessageRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :message, as: 'message', class: Google::Apis::HealthcareV1alpha2::Message, decorator: Google::Apis::HealthcareV1alpha2::Message::Representation + + end + end + + class IngestMessageResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :hl7_ack, :base64 => true, as: 'hl7Ack' + property :message, as: 'message', class: Google::Apis::HealthcareV1alpha2::Message, decorator: Google::Apis::HealthcareV1alpha2::Message::Representation + + end + end + + class ListAnnotationStoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :annotation_stores, as: 'annotationStores', class: Google::Apis::HealthcareV1alpha2::AnnotationStore, decorator: Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListAnnotationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :annotations, as: 'annotations' + property :next_page_token, as: 'nextPageToken' + end + end + + class ListDatasetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :datasets, as: 'datasets', class: Google::Apis::HealthcareV1alpha2::Dataset, decorator: Google::Apis::HealthcareV1alpha2::Dataset::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListDicomStoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dicom_stores, as: 'dicomStores', class: Google::Apis::HealthcareV1alpha2::DicomStore, decorator: Google::Apis::HealthcareV1alpha2::DicomStore::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListFhirStoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fhir_stores, as: 'fhirStores', class: Google::Apis::HealthcareV1alpha2::FhirStore, decorator: Google::Apis::HealthcareV1alpha2::FhirStore::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListHl7V2StoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :hl7_v2_stores, as: 'hl7V2Stores', class: Google::Apis::HealthcareV1alpha2::Hl7V2Store, decorator: Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::HealthcareV1alpha2::Location, decorator: Google::Apis::HealthcareV1alpha2::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListMessagesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :messages, as: 'messages' + property :next_page_token, as: 'nextPageToken' + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::HealthcareV1alpha2::Operation, decorator: Google::Apis::HealthcareV1alpha2::Operation::Representation + + end + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class Message + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :data, :base64 => true, as: 'data' + hash :labels, as: 'labels' + property :message_type, as: 'messageType' + property :name, as: 'name' + property :parsed_data, as: 'parsedData', class: Google::Apis::HealthcareV1alpha2::ParsedData, decorator: Google::Apis::HealthcareV1alpha2::ParsedData::Representation + + collection :patient_ids, as: 'patientIds', class: Google::Apis::HealthcareV1alpha2::PatientId, decorator: Google::Apis::HealthcareV1alpha2::PatientId::Representation + + property :send_facility, as: 'sendFacility' + property :send_time, as: 'sendTime' + end + end + + class NotificationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pubsub_topic, as: 'pubsubTopic' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::HealthcareV1alpha2::Status, decorator: Google::Apis::HealthcareV1alpha2::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_method_name, as: 'apiMethodName' + property :counter, as: 'counter', class: Google::Apis::HealthcareV1alpha2::ProgressCounter, decorator: Google::Apis::HealthcareV1alpha2::ProgressCounter::Representation + + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + end + end + + class ParsedData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :segments, as: 'segments', class: Google::Apis::HealthcareV1alpha2::Segment, decorator: Google::Apis::HealthcareV1alpha2::Segment::Representation + + end + end + + class ParserConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_null_header, as: 'allowNullHeader' + property :segment_terminator, :base64 => true, as: 'segmentTerminator' + end + end + + class PatientId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + property :value, as: 'value' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::HealthcareV1alpha2::AuditConfig, decorator: Google::Apis::HealthcareV1alpha2::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::HealthcareV1alpha2::Binding, decorator: Google::Apis::HealthcareV1alpha2::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class ProgressCounter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :failure, :numeric_string => true, as: 'failure' + property :pending, :numeric_string => true, as: 'pending' + property :success, :numeric_string => true, as: 'success' + end + end + + class RedactConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ReplaceWithInfoTypeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ResourceAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :label, as: 'label' + end + end + + class SchemaConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :recursive_structure_depth, :numeric_string => true, as: 'recursiveStructureDepth' + property :schema_type, as: 'schemaType' + end + end + + class SearchResourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_type, as: 'resourceType' + end + end + + class Segment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :fields, as: 'fields' + property :segment_id, as: 'segmentId' + property :set_id, as: 'setId' + end + end + + class SensitiveTextAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :details, as: 'details', class: Google::Apis::HealthcareV1alpha2::Detail, decorator: Google::Apis::HealthcareV1alpha2::Detail::Representation + + end + end + + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::HealthcareV1alpha2::Policy, decorator: Google::Apis::HealthcareV1alpha2::Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class TagFilterList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :tags, as: 'tags' + end + end + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TextConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :experimental_config, as: 'experimentalConfig' + collection :transformations, as: 'transformations', class: Google::Apis::HealthcareV1alpha2::InfoTypeTransformation, decorator: Google::Apis::HealthcareV1alpha2::InfoTypeTransformation::Representation + + end + end + + class Vertex + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :x, as: 'x' + property :y, as: 'y' + end + end + end + end +end diff --git a/generated/google/apis/healthcare_v1alpha2/service.rb b/generated/google/apis/healthcare_v1alpha2/service.rb new file mode 100644 index 000000000..c07174ee7 --- /dev/null +++ b/generated/google/apis/healthcare_v1alpha2/service.rb @@ -0,0 +1,4011 @@ +# Copyright 2015 Google Inc. +# +# 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. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module HealthcareV1alpha2 + # Cloud Healthcare API + # + # Manage, store, and access healthcare data in Google Cloud Platform. + # + # @example + # require 'google/apis/healthcare_v1alpha2' + # + # Healthcare = Google::Apis::HealthcareV1alpha2 # Alias the module + # service = Healthcare::CloudHealthcareService.new + # + # @see https://cloud.google.com/healthcare + class CloudHealthcareService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://healthcare.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Location] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Location::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Location + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}/locations', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListLocationsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new health dataset. Results are returned through the + # Operation interface which returns either an + # `Operation.response` which contains a Dataset or + # `Operation.error`. The metadata + # field type is OperationMetadata. + # @param [String] parent + # The name of the project in which the dataset should be created (e.g., + # `projects/`project_id`/locations/`location_id``). + # @param [Google::Apis::HealthcareV1alpha2::Dataset] dataset_object + # @param [String] dataset_id + # The ID of the dataset that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/datasets', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation + command.request_object = dataset_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['parent'] = parent unless parent.nil? + command.query['datasetId'] = dataset_id unless dataset_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new dataset containing de-identified data from the source + # dataset. The metadata field type + # is OperationMetadata. + # If the request is successful, the + # response field type is + # DeidentifySummary. + # If errors occur, + # details field type is + # DeidentifyErrorDetails. + # @param [String] source_dataset + # Source dataset resource name. (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``). + # @param [Google::Apis::HealthcareV1alpha2::DeidentifyDatasetRequest] deidentify_dataset_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+sourceDataset}:deidentify', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::DeidentifyDatasetRequest::Representation + command.request_object = deidentify_dataset_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['sourceDataset'] = source_dataset unless source_dataset.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified health dataset and all data contained in the dataset. + # Deleting a dataset does not affect the sources from which the dataset was + # imported (if any). + # @param [String] name + # The name of the dataset to delete (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets any metadata associated with a dataset. + # @param [String] name + # The name of the dataset to read (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Dataset] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Dataset] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Dataset + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the health datasets in the current project. + # @param [String] parent + # The name of the project whose datasets should be listed (e.g., + # `projects/`project_id`/locations/`location_id``). + # @param [Fixnum] page_size + # The maximum number of items to return. Capped to 100 if not specified. + # May not be larger than 1000. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListDatasetsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListDatasetsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/datasets', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListDatasetsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListDatasetsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates dataset metadata. + # @param [String] name + # Output only. Resource name of the dataset, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # @param [Google::Apis::HealthcareV1alpha2::Dataset] dataset_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Dataset] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Dataset] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation + command.request_object = dataset_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Dataset::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Dataset + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Annotation store within the parent dataset. + # @param [String] parent + # The name of the dataset this Annotation store belongs to. + # @param [Google::Apis::HealthcareV1alpha2::AnnotationStore] annotation_store_object + # @param [String] annotation_store_id + # The ID of the Annotation store that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::AnnotationStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::AnnotationStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_annotation_store(parent, annotation_store_object = nil, annotation_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/annotationStores', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation + command.request_object = annotation_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore + command.params['parent'] = parent unless parent.nil? + command.query['annotationStoreId'] = annotation_store_id unless annotation_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified Annotation store and removes all annotations that are + # contained within it. + # @param [String] name + # The resource name of the Annotation store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the specified Annotation store or returns NOT_FOUND if it does not + # exist. + # @param [String] name + # The resource name of the Annotation store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::AnnotationStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::AnnotationStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_annotation_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. Returns NOT_FOUND error if + # the resource does not exist. Returns an empty policy if the resource exists + # but does not have a policy set. + # Authorization requires the Google IAM permission + # `healthcare.AnnotationStores.getIamPolicy` on the specified resource + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::GetIamPolicyRequest] get_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_annotation_store_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:getIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::GetIamPolicyRequest::Representation + command.request_object = get_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the Annotation stores in the given dataset for a source store. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported, for example `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of Annotation stores to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_annotation_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/annotationStores', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListAnnotationStoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified Annotation store. + # @param [String] name + # Output only. Resource name of the Annotation store, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # annotationStores/`annotation_store_id``. + # @param [Google::Apis::HealthcareV1alpha2::AnnotationStore] annotation_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::AnnotationStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::AnnotationStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_annotation_store(name, annotation_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation + command.request_object = annotation_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::AnnotationStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::AnnotationStore + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # POLICIES + # Sets the access control policy for a resource. Replaces any existing + # policy. + # Authorization requires the Google IAM permission + # 'healthcare.annotationStores.setIamPolicy' on the specified resource + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_annotation_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # There is no permission required to make this API call. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_annotation_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Annotation record. It is + # valid to create Annotation objects for the same source more than once since + # a unique ID is assigned to each record by this service. + # @param [String] parent + # The name of the Annotation store this annotation belongs to. For example, + # `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/ + # myannotationstore`. + # @param [Google::Apis::HealthcareV1alpha2::Annotation] annotation_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Annotation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Annotation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_annotation_store_annotation(parent, annotation_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/annotations', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation + command.request_object = annotation_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Annotation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an Annotation or returns + # NOT_FOUND if it does not exist. + # @param [String] name + # The resource name of the Annotation to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an Annotation. + # @param [String] name + # The resource name of the Annotation to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Annotation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Annotation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_annotation_store_annotation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Annotation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the Annotations in the given + # Annotation store for a source + # resource. + # @param [String] parent + # Name of the Annotation store to retrieve Annotations from. + # @param [String] filter + # Restricts Annotations returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Fields/functions available for filtering are: + # - source_version + # @param [Fixnum] page_size + # Limit on the number of Annotations to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_annotation_store_annotations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/annotations', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListAnnotationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the Annotation. + # @param [String] name + # Output only. Resource name of the Annotation, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # annotationStores/`annotation_store_id`/annotations/`annotation_id``. + # @param [Google::Apis::HealthcareV1alpha2::Annotation] annotation_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Annotation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Annotation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_annotation_store_annotation(name, annotation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation + command.request_object = annotation_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Annotation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Annotation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new DICOM store within the parent dataset. + # @param [String] parent + # The name of the dataset this DICOM store belongs to. + # @param [Google::Apis::HealthcareV1alpha2::DicomStore] dicom_store_object + # @param [String] dicom_store_id + # The ID of the DICOM store that is being created. + # Any string value up to 256 characters in length. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::DicomStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::DicomStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomStores', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation + command.request_object = dicom_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore + command.params['parent'] = parent unless parent.nil? + command.query['dicomStoreId'] = dicom_store_id unless dicom_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified DICOM store and removes all images that are contained + # within it. + # @param [String] name + # The resource name of the DICOM store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Exports data to the specified destination by copying it from the DICOM + # store. + # The metadata field type is + # OperationMetadata. + # @param [String] name + # The DICOM store resource name from which the data should be exported (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [Google::Apis::HealthcareV1alpha2::ExportDicomDataRequest] export_dicom_data_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def export_dicom_store_dicom_data(name, export_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+name}:export', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::ExportDicomDataRequest::Representation + command.request_object = export_dicom_data_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the specified DICOM store. + # @param [String] name + # The resource name of the DICOM store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::DicomStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::DicomStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_dicom_store_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Imports data into the DICOM store by copying it from the specified source. + # For errors, the Operation will be populated with error details (in the form + # of ImportDicomDataErrorDetails in error.details), which will hold + # finer-grained error information. + # The metadata field type is + # OperationMetadata. + # @param [String] name + # The name of the DICOM store resource into which the data is imported (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [Google::Apis::HealthcareV1alpha2::ImportDicomDataRequest] import_dicom_data_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_dicom_store_dicom_data(name, import_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+name}:import', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::ImportDicomDataRequest::Representation + command.request_object = import_dicom_data_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the DICOM stores in the given dataset. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported, for example `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of DICOM stores to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomStores', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListDicomStoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified DICOM store. + # @param [String] name + # Output only. Resource name of the DICOM store, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [Google::Apis::HealthcareV1alpha2::DicomStore] dicom_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::DicomStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::DicomStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation + command.request_object = dicom_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::DicomStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::DicomStore + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_dicom_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_dicom_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForInstances returns a list of matching instances. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `instances`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_dicom_web_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForSeries returns a list of matching series. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `series`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_dicom_web_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForStudies returns a list of matching studies. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_dicom_web_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # StoreInstances stores DICOM instances associated with study instance unique + # identifiers (SUID). See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id``). + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def store_project_location_dataset_dicom_store_dicom_web_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # DeleteStudy deletes all instances within the given study. Delete requests + # are equivalent to the GET requests specified in the WADO-RS standard. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveStudyMetadata returns instance associated with the given study + # presented as metadata with the bulk data removed. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id`/metadata`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def metadata_project_location_dataset_dicom_store_dicom_web_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveStudy returns all instances within the given study. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_dicom_web_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForInstances returns a list of matching instances. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `instances`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_dicom_web_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForSeries returns a list of matching series. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `series`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_dicom_web_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # StoreInstances stores DICOM instances associated with study instance unique + # identifiers (SUID). See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id``). + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def store_project_location_dataset_dicom_store_dicom_web_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # DeleteSeries deletes all instances within the given study and series. + # Delete requests are equivalent to the GET requests specified in the WADO-RS + # standard. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id`/series/`series_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveSeriesMetadata returns instance associated with the given study and + # series, presented as metadata with the bulk data removed. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id`/series/`series_id`/metadata`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def metadata_project_location_dataset_dicom_store_dicom_web_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveSeries returns all instances within the given study and series. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., `studies/`study_id`/series/`series_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_dicom_web_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForInstances returns a list of matching instances. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7 + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `instances`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_dicom_web_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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 WADO-RS standard. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies/`study_id`/series/`series_id`/instances/`instance_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveInstanceMetadata returns instance associated with the given study, + # series, and SOP Instance UID presented as metadata with the bulk data + # removed. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies/`study_id`/series/`series_id`/instances/`instance_id`/metadata`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def metadata_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveRenderedInstance returns instance associated with the given study, + # series, and SOP Instance UID in an acceptable Rendered Media Type. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies/`study_id`/series/`series_id`/instance/`instance_id`/rendered`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveInstance returns instance associated with the given study, series, + # and SOP Instance UID. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies/`study_id`/series/`series_id`/instance/`instance_id``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveRenderedFrames returns instances associated with the given study, + # series, SOP Instance UID and frame numbers in an acceptable Rendered Media + # Type. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies/`study_id`/series/`series_id`/instance/`instance_id`/frames/` + # frame_list`/rendered`). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def rendered_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveFrames returns instances associated with the given study, series, + # SOP Instance UID and frame numbers. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4. + # @param [String] parent + # The name of the DICOM store that is being accessed (e.g., + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``). + # @param [String] dicom_web_path + # The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or + # QIDO-RS standard (e.g., + # `studies/`study_id`/series/`series_id`/instance/`instance_id`/frames/` + # frame_list``). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_dicom_web_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the FHIR [capability + # statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement. + # html) + # for the store, which contains a description of functionality supported by + # the server. + # Implements the FHIR standard [capabilities + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html# + # capabilities). + # On success, the response body will contain a JSON-encoded representation + # of a `CapabilityStatement` resource. + # @param [String] name + # Name of the FHIR store to retrieve the capabilities for. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def capabilities_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}/metadata', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new FHIR store within the parent dataset. + # @param [String] parent + # The name of the dataset this FHIR store belongs to. + # @param [Google::Apis::HealthcareV1alpha2::FhirStore] fhir_store_object + # @param [String] fhir_store_id + # The ID of the FHIR store that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::FhirStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::FhirStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_fhir_store(parent, fhir_store_object = nil, fhir_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/fhirStores', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation + command.request_object = fhir_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore + command.params['parent'] = parent unless parent.nil? + command.query['fhirStoreId'] = fhir_store_id unless fhir_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified FHIR store and removes all resources within it. + # @param [String] name + # The resource name of the FHIR store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # 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. + # @param [String] name + # The name of the FHIR store to export resource from. The name should be in + # the format of + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1alpha2::ExportResourcesRequest] export_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+name}:export', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::ExportResourcesRequest::Representation + command.request_object = export_resources_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the configuration of the specified FHIR store. + # @param [String] name + # The resource name of the FHIR store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::FhirStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::FhirStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a FHIR store or security label within a + # FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns + # an empty policy if the resource exists but does not have a policy set. + # Authorization requires the Google IAM permission + # 'healthcare.fhirStores.getIamPolicy' for a FHIR store or + # 'healthcare.securityLabels.getIamPolicy' for a security label + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_fhir_store_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Import resources to the FHIR store by loading data from the specified + # sources. Each resource must have a client-supplied ID, which is retained + # by the server. + # The import operation is idempotent. Upon retry, the most recent data + # (matching the client-supplied ID) is overwritten, without creating a new + # resource version. If partial failures occur during the import, successful + # changes are not rolled back. + # If history imports are enabled + # (enable_history_import is set in the + # FHIR store's configuration), you can import historical versions of a + # resource by supplying a bundle of type `history`. The historical versions + # in the bundle must have `lastUpdated` timestamps. If a current or + # historical version with the supplied resource ID already exists, the + # bundle is rejected. + # 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. + # 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. + # @param [String] name + # The name of the FHIR store to import FHIR resources to. The name should be + # in the format of + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1alpha2::ImportResourcesRequest] import_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+name}:import', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::ImportResourcesRequest::Representation + command.request_object = import_resources_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the FHIR stores in the given dataset. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported, for example `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of FHIR stores to return in a single response. If zero + # the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_fhir_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/fhirStores', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListFhirStoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the configuration of the specified FHIR store. + # @param [String] name + # Output only. Resource name of the FHIR store, of the form + # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1alpha2::FhirStore] fhir_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::FhirStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::FhirStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_fhir_store(name, fhir_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation + command.request_object = fhir_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::FhirStore::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::FhirStore + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy for a FHIR store or security label within a + # FHIR store. Replaces any existing policy. + # Authorization requires the Google IAM permission + # 'healthcare.fhirStores.setIamPolicy' for a FHIR store or + # 'healthcare.securityLabels.setIamPolicy' for a security label + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_fhir_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # There is no permission required to make this API call. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_fhir_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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](http://hl7.org/implement/standards/fhir/STU3/observation- + # operations.html#lastn). + # Search terms are provided as query parameters following the same pattern as + # the search method. 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. + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # operation. + # Errors generated by the FHIR store will 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. + # @param [String] parent + # Name of the FHIR store to retrieve resources from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def observation_project_location_dataset_fhir_store_fhir_lastn(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/fhir/Observation/$lastn', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves all the resources in the patient compartment for a `Patient` + # resource. + # Implements the FHIR extended operation + # [Patient-everything](http://hl7.org/implement/standards/fhir/STU3/patient- + # operations.html#everything). + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # operation. + # Errors generated by the FHIR store will 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. + # @param [String] name + # Name of the `Patient` resource for which the information is required. + # @param [String] end_ + # The response includes records prior to the end date. If no end date is + # provided, all records subsequent to the start date are in scope. + # @param [String] start + # The response includes records subsequent to the start date. If no start + # date is provided, all records prior to the end date are in scope. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patient_project_location_dataset_fhir_store_fhir_everything(name, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}/$everything', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['end'] = end_ unless end_.nil? + command.query['start'] = start unless start.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] name + # The name of the resource to purge. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}/$purge', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the FHIR [capability + # statement](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement. + # html) + # for the store, which contains a description of functionality supported by + # the server. + # Implements the FHIR standard [capabilities + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html# + # capabilities). + # On success, the response body will contain a JSON-encoded representation + # of a `CapabilityStatement` resource. + # @param [String] name + # Name of the FHIR store to retrieve the capabilities for. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}/fhir/metadata', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes FHIR resources that match a search query. + # Implements the FHIR standard [conditional delete + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13. + # 1). + # If multiple resources match, all of them will be deleted. + # Search terms are provided as query parameters following the same pattern as + # the search method. + # Note: Unless resource versioning is disabled by setting the + # disable_resource_versioning flag + # on the FHIR store, the deleted resources will be moved to a history + # repository that can still be retrieved through vread + # and related methods, unless they are removed by the + # purge method. + # @param [String] parent + # The name of the FHIR store this resource belongs to. + # @param [String] type + # The FHIR resource type to delete, such as Patient or Observation. For a + # complete list, see the [FHIR Resource + # Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def conditional_project_location_dataset_fhir_store_fhir_delete(parent, type, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+parent}/fhir/{+type}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # If a resource is found based on the search criteria 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](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). + # Search terms are provided as query parameters following the same pattern as + # the search method. + # If the search criteria identify more than one match, the request will + # return 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 will contain a JSON-encoded representation + # of the updated resource, including the server-assigned version ID. + # Errors generated by the FHIR store will 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. + # @param [String] parent + # The name of the FHIR store this resource belongs to. + # @param [String] type + # The FHIR resource type to update, such as Patient or Observation. For a + # complete list, see the [FHIR Resource + # Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def conditional_project_location_dataset_fhir_store_fhir_patch(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+parent}/fhir/{+type}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # If a resource is found based on the search criteria specified in the query + # parameters, updates the entire contents of that resource. + # Implements the FHIR standard [conditional update + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cond- + # update). + # Search terms are provided as query parameters following the same pattern as + # the search method. + # If the search criteria identify more than one match, the request will + # return 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. If the search criteria identify zero + # matches, and the supplied resource body does not contain an `id`, the + # resource will be 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 will contain a JSON-encoded representation + # of the updated resource, including the server-assigned version ID. + # Errors generated by the FHIR store will 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. + # @param [String] parent + # The name of the FHIR store this resource belongs to. + # @param [String] type + # The FHIR resource type to update, such as Patient or Observation. For a + # complete list, see the [FHIR Resource + # Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + # Must match the resource type in the provided content. + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def conditional_project_location_dataset_fhir_store_fhir_update(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1alpha2/{+parent}/fhir/{+type}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a FHIR resource. + # Implements the FHIR standard [create + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#create), + # which creates a new resource with a server-assigned resource ID. + # Also supports the FHIR standard [conditional create + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), + # specified by supplying an `If-None-Exist` header containing a FHIR search + # query. If no resources match this search query, the server processes the + # create operation as normal. + # 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 will contain 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 will 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. + # @param [String] parent + # The name of the FHIR store this resource belongs to. + # @param [String] type + # The FHIR resource type to create, such as Patient or Observation. For a + # complete list, see the [FHIR Resource + # Index](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html). + # Must match the resource type in the provided content. + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_fhir_store_fhir(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir/{+type}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a FHIR resource. + # Implements the FHIR standard [delete + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#delete). + # Note: Unless resource versioning is disabled by setting the + # disable_resource_versioning flag + # on the FHIR store, the deleted resources will be moved to a history + # repository that can still be retrieved through vread + # and related methods, unless they are removed by the + # purge method. + # @param [String] name + # The name of the resource to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Executes all the requests in the given Bundle. + # Implements the FHIR standard [batch/transaction + # interaction](http://hl7.org/implement/standards/fhir/STU3/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](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1) + # and [transaction processing + # rules](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2). + # 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 will + # contain 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 will 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. + # @param [String] parent + # Name of the FHIR store in which this bundle will be executed. + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def execute_project_location_dataset_fhir_store_fhir_bundle(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the versions of a resource (including the current version and + # deleted versions) from the FHIR store. + # Implements the per-resource form of the FHIR standard [history + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#history). + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `history`, containing the version history + # sorted from most recent to oldest versions. + # Errors generated by the FHIR store will 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. + # @param [String] name + # The name of the resource to retrieve. + # @param [String] at + # Only include resource versions that were current at some point during the + # time period specified in the date time value. The date parameter format is + # yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] + # Clients may specify any of the following: + # * An entire year: `_at=2019` + # * An entire month: `_at=2019-01` + # * A specific day: `_at=2019-01-20` + # * A specific second: `_at=2018-12-31T23:59:58Z` + # @param [Fixnum] count + # The maximum number of search results on a page. Defaults to 1000. + # @param [String] page + # Used to retrieve the first, previous, next, or last page of resource + # versions when using pagination. Value should be set to the value of the + # `link.url` field returned in the response to the previous request, where + # `link.relation` is "first", "previous", "next" or "last". + # Omit `page` if no previous request has been made. + # @param [String] since + # Only include resource versions that were created at or after the given + # instant in time. The instant in 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. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def history_project_location_dataset_fhir_store_fhir(name, at: nil, count: nil, page: nil, since: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}/_history', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['at'] = at unless at.nil? + command.query['count'] = count unless count.nil? + command.query['page'] = page unless page.nil? + command.query['since'] = since unless since.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates part of an existing resource by applying the operations specified + # in a [JSON Patch](http://jsonpatch.com/) document. + # Implements the FHIR standard [patch + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#patch). + # 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 will contain a JSON-encoded representation + # of the updated resource, including the server-assigned version ID. + # Errors generated by the FHIR store will 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. + # @param [String] name + # The name of the resource to update. + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the contents of a FHIR resource. + # Implements the FHIR standard [read + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#read). + # Also supports the FHIR standard [conditional read + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#cread) + # specified by supplying an `If-Modified-Since` header with a date/time value + # or an `If-None-Match` header with an ETag value. + # On success, the response body will contain a JSON-encoded representation + # of the resource. + # Errors generated by the FHIR store will 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. + # @param [String] name + # The name of the resource to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Searches for resources in the given FHIR store according to criteria + # specified as query parameters. + # Implements the FHIR standard [search + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#search) + # using the search semantics described in the [FHIR Search + # specification](http://hl7.org/implement/standards/fhir/STU3/search.html). + # Supports three 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]/[type]/_search?[parameters]` as an alternate form having + # the same semantics as the `GET` method. + # The `GET` methods do not support compartment searches. The `POST` method + # does not support `application/x-www-form-urlencoded` search parameters. + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # search. + # Errors generated by the FHIR store will 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. + # # Search Parameters + # 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](http://hl7.org/implement/standards/fhir/STU3/searchparameter- + # registry.html). + # # Search Modifiers + # Modifier | Supported + # ----------- | --------- + # `:missing` | Yes + # `:exact` | Yes + # `:contains` | Yes + # `:text` | Yes + # `:in` | Yes + # `:not-in` | Yes + # `:above` | Yes + # `:below` | Yes + # `:[type]` | Yes + # `:not` | Yes + # `:recurse` | No + # @param [String] parent + # Name of the FHIR store to retrieve resources from. + # @param [Google::Apis::HealthcareV1alpha2::SearchResourcesRequest] search_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/fhir/_search', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SearchResourcesRequest::Representation + command.request_object = search_resources_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the entire contents of a resource. + # Implements the FHIR standard [update + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#update). + # If the specified resource does + # not exist and the FHIR store has + # enable_update_create set, creates the + # resource with the client-specified ID. + # The request body must contain a JSON-encoded FHIR resource, and the request + # headers must contain `Content-Type: application/fhir+json`. The resource + # must contain an `id` element having an identical value to the ID in the + # REST path of the request. + # On success, the response body will contain a JSON-encoded representation + # of the updated resource, including the server-assigned version ID. + # Errors generated by the FHIR store will 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. + # @param [String] name + # The name of the resource to update. + # @param [Google::Apis::HealthcareV1alpha2::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the contents of a version (current or historical) of a FHIR resource + # by version ID. + # Implements the FHIR standard [vread + # interaction](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). + # On success, the response body will contain a JSON-encoded representation + # of the resource. + # Errors generated by the FHIR store will 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. + # @param [String] name + # The name of the resource version to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a FHIR store or security label within a + # FHIR store. Returns NOT_FOUND error if the resource does not exist. Returns + # an empty policy if the resource exists but does not have a policy set. + # Authorization requires the Google IAM permission + # 'healthcare.fhirStores.getIamPolicy' for a FHIR store or + # 'healthcare.securityLabels.getIamPolicy' for a security label + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_fhir_store_security_label_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy for a FHIR store or security label within a + # FHIR store. Replaces any existing policy. + # Authorization requires the Google IAM permission + # 'healthcare.fhirStores.setIamPolicy' for a FHIR store or + # 'healthcare.securityLabels.setIamPolicy' for a security label + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_security_label_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new HL7v2 store within the parent dataset. + # @param [String] parent + # The name of the dataset this HL7v2 store belongs to. + # @param [Google::Apis::HealthcareV1alpha2::Hl7V2Store] hl7_v2_store_object + # @param [String] hl7_v2_store_id + # The ID of the HL7v2 store that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Hl7V2Store] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Hl7V2Store] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_hl7_v2_store(parent, hl7_v2_store_object = nil, hl7_v2_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/hl7V2Stores', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation + command.request_object = hl7_v2_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store + command.params['parent'] = parent unless parent.nil? + command.query['hl7V2StoreId'] = hl7_v2_store_id unless hl7_v2_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified HL7v2 store and removes all messages that are + # contained within it. + # @param [String] name + # The resource name of the HL7v2 store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the specified HL7v2 store. + # @param [String] name + # The resource name of the HL7v2 store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Hl7V2Store] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Hl7V2Store] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_hl7_v2_store_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the HL7v2 stores in the given dataset. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported, for example `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of HL7v2 stores to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_hl7_v2_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/hl7V2Stores', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListHl7V2StoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the HL7v2 store. + # @param [String] name + # Output only. Resource name of the HL7v2 store, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # @param [Google::Apis::HealthcareV1alpha2::Hl7V2Store] hl7_v2_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Hl7V2Store] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Hl7V2Store] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_hl7_v2_store(name, hl7_v2_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation + command.request_object = hl7_v2_store_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Hl7V2Store::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Hl7V2Store + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_hl7_v2_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Policy::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_hl7_v2_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a message and sends a notification to the Cloud Pub/Sub topic. If + # configured, the MLLP adapter listens to messages created by this method and + # sends those back to the hospital. A successful response indicates the + # message has been persisted to storage and a Cloud Pub/Sub notification has + # been sent. Sending to the hospital by the MLLP adapter happens + # asynchronously. + # @param [String] parent + # The name of the dataset this message belongs to. + # @param [Google::Apis::HealthcareV1alpha2::CreateMessageRequest] create_message_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Message] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Message] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/messages', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::CreateMessageRequest::Representation + command.request_object = create_message_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Message + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an HL7v2 message. + # @param [String] name + # The resource name of the HL7v2 message to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Empty::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an HL7v2 message. + # @param [String] name + # The resource name of the HL7v2 message to retrieve. + # @param [String] view + # Specifies which parts of the Message resource should be returned + # in the response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Message] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Message] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_hl7_v2_store_message(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Message + command.params['name'] = name unless name.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Ingests a new HL7v2 message from the hospital and sends a notification to + # the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was + # successfully stored. Otherwise an error is returned. If an identical + # HL7v2 message is created twice only one resource is created on the server + # and no error is reported. + # @param [String] parent + # The name of the HL7v2 store this message belongs to. + # @param [Google::Apis::HealthcareV1alpha2::IngestMessageRequest] ingest_message_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::IngestMessageResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::IngestMessageResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha2/{+parent}/messages:ingest', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::IngestMessageRequest::Representation + command.request_object = ingest_message_request_object + command.response_representation = Google::Apis::HealthcareV1alpha2::IngestMessageResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::IngestMessageResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the messages in the given HL7v2 store with support for filtering. + # @param [String] parent + # Name of the HL7v2 store to retrieve messages from. + # @param [String] filter + # Restricts messages returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Fields/functions available for filtering are: + # * `message_type`, from the MSH-9 segment; 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 of 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"` + # * `send_facility`, the care center that the message came from, from the + # MSH-4 segment; for example `send_facility = "ABC"` + # * `HL7RegExp(expr)`, which does regular expression matching of `expr` + # against the message payload using re2 (http://code.google.com/p/re2/) + # syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` + # * `PatientId(value, type)`, which matches if the message lists a patient + # having an ID of the given value and type in the PID-2, PID-3, or PID-4 + # segments; for example `PatientId("123456", "MRN")` + # * `labels.x`, a string value of the label with key `x` as set using the + # Message.labels + # map, for example `labels."priority"="high"`. The operator `:*` can be used + # to assert the existence of a label, for example `labels."priority":*`. + # Limitations on conjunctions: + # * Negation on the patient ID function or the labels field is not + # supported, for example these queries are invalid: + # `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, + # `NOT labels."tag2"="val2"`. + # * Conjunction of multiple patient ID functions is not supported, for + # example this query is invalid: + # `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. + # * Conjunction of multiple labels fields is also not supported, for + # example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. + # * Conjunction of one patient ID function, one labels field and conditions + # on other fields is supported, for example this query is valid: + # `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. + # The HasLabel(x) and Label(x) syntax from previous API versions are + # deprecated; replaced by the `labels.x` syntax. + # @param [String] order_by + # Orders messages returned by the specified order_by clause. + # Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order + # Fields available for ordering are: + # * `send_time` + # @param [Fixnum] page_size + # Limit on the number of messages to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListMessagesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListMessagesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+parent}/messages', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListMessagesResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListMessagesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Update the message. + # @param [String] name + # Resource name of the Message, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/ + # messages/`message_id``. + # Assigned by the server. + # @param [Google::Apis::HealthcareV1alpha2::Message] message_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # Only the `labels` field is allowed to be updated. + # The labels in the request will be merged with the existing set of labels. + # Existing labels with the same keys will be updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Message] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Message] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_hl7_v2_store_message(name, message_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha2/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1alpha2::Message::Representation + command.request_object = message_object + command.response_representation = Google::Apis::HealthcareV1alpha2::Message::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Message + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::Operation::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # 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. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1alpha2::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1alpha2::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha2/{+name}/operations', options) + command.response_representation = Google::Apis::HealthcareV1alpha2::ListOperationsResponse::Representation + command.response_class = Google::Apis::HealthcareV1alpha2::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/testing_v1.rb b/generated/google/apis/testing_v1.rb index 489883f78..7f1b3d04b 100644 --- a/generated/google/apis/testing_v1.rb +++ b/generated/google/apis/testing_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-test-lab/ module TestingV1 VERSION = 'V1' - REVISION = '20190424' + REVISION = '20190514' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/testing_v1/classes.rb b/generated/google/apis/testing_v1/classes.rb index 3a21ef3c4..0e0b3cf59 100644 --- a/generated/google/apis/testing_v1/classes.rb +++ b/generated/google/apis/testing_v1/classes.rb @@ -27,7 +27,7 @@ module Google include Google::Apis::Core::Hashable # Enables automatic Google account login. - # If set, the service will automatically generate a Google test account and add + # If set, the service automatically generates a Google test account and adds # it to the device, before executing the test. Note that test accounts might be # reused. # Many applications show their full set of functionalities when an account is @@ -1027,7 +1027,7 @@ module Google end # Enables automatic Google account login. - # If set, the service will automatically generate a Google test account and add + # If set, the service automatically generates a Google test account and adds # it to the device, before executing the test. Note that test accounts might be # reused. # Many applications show their full set of functionalities when an account is @@ -1277,7 +1277,7 @@ module Google end end - # A description of how to set up an iOS device prior to a test. + # A description of how to set up an iOS device prior to running the test. class IosTestSetup include Google::Apis::Core::Hashable @@ -1627,6 +1627,11 @@ module Google # @return [Google::Apis::TestingV1::GoogleCloudStorage] attr_accessor :google_cloud_storage + # Output only. URL to the results in the Firebase Web Console. + # Corresponds to the JSON property `resultsUrl` + # @return [String] + attr_accessor :results_url + # Represents a tool results execution resource. # This has the results of a TestMatrix. # Corresponds to the JSON property `toolResultsExecution` @@ -1645,6 +1650,7 @@ module Google # Update properties of this object def update!(**args) @google_cloud_storage = args[:google_cloud_storage] if args.key?(:google_cloud_storage) + @results_url = args[:results_url] if args.key?(:results_url) @tool_results_execution = args[:tool_results_execution] if args.key?(:tool_results_execution) @tool_results_history = args[:tool_results_history] if args.key?(:tool_results_history) end @@ -1819,7 +1825,7 @@ module Google end end - # Specifies a single test to be executed in a single environment. + # A single test executed in a single environment. class TestExecution include Google::Apis::Core::Hashable @@ -1828,7 +1834,7 @@ module Google # @return [Google::Apis::TestingV1::Environment] attr_accessor :environment - # Output only. Unique id set by the backend. + # Output only. Unique id set by the service. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1888,8 +1894,9 @@ module Google end end - # A group of one or more TestExecutions, built by taking a - # product of values over a pre-defined set of axes. + # TestMatrix captures all details about a test. It contains the environment + # configuration, test specification, test executions and overall state and + # outcome. class TestMatrix include Google::Apis::Core::Hashable @@ -1917,6 +1924,12 @@ module Google # @return [String] attr_accessor :invalid_matrix_details + # Output Only. The overall outcome of the test. + # Only set when the test matrix state is FINISHED. + # Corresponds to the JSON property `outcomeSummary` + # @return [String] + attr_accessor :outcome_summary + # The cloud project that owns the test matrix. # Corresponds to the JSON property `projectId` # @return [String] @@ -1927,8 +1940,7 @@ module Google # @return [Google::Apis::TestingV1::ResultStorage] attr_accessor :result_storage - # Output only. Indicates the current progress of the test matrix - # (e.g., FINISHED). + # Output only. Indicates the current progress of the test matrix. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -1964,6 +1976,7 @@ module Google @environment_matrix = args[:environment_matrix] if args.key?(:environment_matrix) @flaky_test_attempts = args[:flaky_test_attempts] if args.key?(:flaky_test_attempts) @invalid_matrix_details = args[:invalid_matrix_details] if args.key?(:invalid_matrix_details) + @outcome_summary = args[:outcome_summary] if args.key?(:outcome_summary) @project_id = args[:project_id] if args.key?(:project_id) @result_storage = args[:result_storage] if args.key?(:result_storage) @state = args[:state] if args.key?(:state) @@ -2063,19 +2076,19 @@ module Google # @return [Google::Apis::TestingV1::AndroidTestLoop] attr_accessor :android_test_loop - # Disables performance metrics recording; may reduce test latency. + # Disables performance metrics recording. May reduce test latency. # Corresponds to the JSON property `disablePerformanceMetrics` # @return [Boolean] attr_accessor :disable_performance_metrics alias_method :disable_performance_metrics?, :disable_performance_metrics - # Disables video recording; may reduce test latency. + # Disables video recording. May reduce test latency. # Corresponds to the JSON property `disableVideoRecording` # @return [Boolean] attr_accessor :disable_video_recording alias_method :disable_video_recording?, :disable_video_recording - # A description of how to set up an iOS device prior to a test. + # A description of how to set up an iOS device prior to running the test. # Corresponds to the JSON property `iosTestSetup` # @return [Google::Apis::TestingV1::IosTestSetup] attr_accessor :ios_test_setup diff --git a/generated/google/apis/testing_v1/representations.rb b/generated/google/apis/testing_v1/representations.rb index e2632fcda..f866fb81c 100644 --- a/generated/google/apis/testing_v1/representations.rb +++ b/generated/google/apis/testing_v1/representations.rb @@ -839,6 +839,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :google_cloud_storage, as: 'googleCloudStorage', class: Google::Apis::TestingV1::GoogleCloudStorage, decorator: Google::Apis::TestingV1::GoogleCloudStorage::Representation + property :results_url, as: 'resultsUrl' property :tool_results_execution, as: 'toolResultsExecution', class: Google::Apis::TestingV1::ToolResultsExecution, decorator: Google::Apis::TestingV1::ToolResultsExecution::Representation property :tool_results_history, as: 'toolResultsHistory', class: Google::Apis::TestingV1::ToolResultsHistory, decorator: Google::Apis::TestingV1::ToolResultsHistory::Representation @@ -925,6 +926,7 @@ module Google property :flaky_test_attempts, as: 'flakyTestAttempts' property :invalid_matrix_details, as: 'invalidMatrixDetails' + property :outcome_summary, as: 'outcomeSummary' property :project_id, as: 'projectId' property :result_storage, as: 'resultStorage', class: Google::Apis::TestingV1::ResultStorage, decorator: Google::Apis::TestingV1::ResultStorage::Representation