google-apis-healthcare_v1 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26a082b9cf2017054d6ba4778e3cf087de052329d33f56d3aac94e3a86735cc3
-  data.tar.gz: 07b67fb286bada96e51fbd8b14a7750c8ff079e6d8cc8cc5d3a97730e4affc34
+  metadata.gz: 98652121566257e018eca80e376a00cd67ba0a6463e6659f2c0e300803ebb75f
+  data.tar.gz: 3ce1650516a7f412c7c7708476502cc816a52259bb2612439dd20fd78a81d4b3
 SHA512:
-  metadata.gz: 4b2dd39757a3ac00c0449fc63c7f81c393e94f47282184cbb1be4b83a8da3f3d393305dda8cf099a15a725f6f061bdcc51bee93ac4acaf68e39ebe6a774a14ee
-  data.tar.gz: 81e07d668bc8b28eb64d50cb274a74775335f1196d9ccf2ea90f8de0e3cdf3f74913e62c014e2a323d7e2ca51d50ee01603152061ba7f6e0f5222884a9f4d3e7
+  metadata.gz: 737f751a46d1e201e53ac36ae7782a3078263a085b424ea6d5ba18c2c05bfca7346e3d018722935c704436a32c441ff062313a1d9f976e5a4bc4fa3a245107d4
+  data.tar.gz: a197a0a28a142a416f2c3fdb9e5a4834f039efdc12559a389e4021a25a3f8ff6eb02033fa6774165068f9cc193644fd222540f75895a71ca3f03fa0eaf009fb7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-healthcare_v1
 
+### v0.15.0 (2021-10-01)
+
+* Regenerated from discovery document revision 20210917
+
 ### v0.14.0 (2021-09-24)
 
 * Regenerated from discovery document revision 20210914

data/lib/google/apis/healthcare_v1/classes.rb

@@ -1374,6 +1374,63 @@ module Google
         end
       end
       
+      # Request to schedule an export.
+      class ExportMessagesRequest
+        include Google::Apis::Core::Hashable
+      
+        # The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/
+        # public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process.
+        # If not specified, the time when the export is scheduled is used. This value
+        # has to come after the `start_time` defined below. Only messages whose `
+        # send_time` lies in the range `start_time` (inclusive) to `end_time` (exclusive)
+        # are exported.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # The Cloud Storage output destination. The Cloud Healthcare Service Agent
+        # requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage
+        # location.
+        # Corresponds to the JSON property `gcsDestination`
+        # @return [Google::Apis::HealthcareV1::GcsDestination]
+        attr_accessor :gcs_destination
+      
+        # The start of the range in `send_time` (MSH.7, https://www.hl7.org/
+        # documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.
+        # htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is
+        # used. This value has to come before the `end_time` defined below. Only
+        # messages whose `send_time` lies in the range `start_time` (inclusive) to `
+        # end_time` (exclusive) are exported.
+        # Corresponds to the JSON property `startTime`
+        # @return [String]
+        attr_accessor :start_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
+          @start_time = args[:start_time] if args.key?(:start_time)
+        end
+      end
+      
+      # Final response for the export operation. This structure is included in the
+      # response to describe the detailed outcome.
+      class ExportMessagesResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Request to export resources.
       class ExportResourcesRequest
         include Google::Apis::Core::Hashable
@@ -1730,6 +1787,71 @@ module Google
         end
       end
       
+      # The Cloud Storage output destination. The Cloud Healthcare Service Agent
+      # requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage
+      # location.
+      class GcsDestination
+        include Google::Apis::Core::Hashable
+      
+        # The format of the exported HL7v2 message files.
+        # Corresponds to the JSON property `contentStructure`
+        # @return [String]
+        attr_accessor :content_structure
+      
+        # Specifies the parts of the Message resource to include in the export. If not
+        # specified, FULL is used.
+        # Corresponds to the JSON property `messageView`
+        # @return [String]
+        attr_accessor :message_view
+      
+        # URI of an existing Cloud Storage directory where the server writes result
+        # files, in the format `gs://`bucket-id`/`path/to/destination/dir``. If there is
+        # no trailing slash, the service appends one when composing the object path.
+        # 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)
+          @content_structure = args[:content_structure] if args.key?(:content_structure)
+          @message_view = args[:message_view] if args.key?(:message_view)
+          @uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix)
+        end
+      end
+      
+      # Specifies the configuration for importing data from Cloud Storage.
+      class GcsSource
+        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
+      
       # The Cloud Storage location for export.
       class GoogleCloudHealthcareV1ConsentGcsDestination
         include Google::Apis::Core::Hashable
@@ -2379,6 +2501,40 @@ module Google
         end
       end
       
+      # Request to import messages.
+      class ImportMessagesRequest
+        include Google::Apis::Core::Hashable
+      
+        # Specifies the configuration for importing data from Cloud Storage.
+        # Corresponds to the JSON property `gcsSource`
+        # @return [Google::Apis::HealthcareV1::GcsSource]
+        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
+      
+      # Final response of importing messages. This structure is included in the
+      # response to describe the detailed outcome. It is only included when the
+      # operation finishes successfully.
+      class ImportMessagesResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Request to import resources.
       class ImportResourcesRequest
         include Google::Apis::Core::Hashable

data/lib/google/apis/healthcare_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module HealthcareV1
       # Version of the google-apis-healthcare_v1 gem
-      GEM_VERSION = "0.14.0"
+      GEM_VERSION = "0.15.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210914"
+      REVISION = "20210917"
     end
   end
 end

data/lib/google/apis/healthcare_v1/representations.rb

@@ -256,6 +256,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExportMessagesRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ExportMessagesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ExportResourcesRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -310,6 +322,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GcsDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GcsSource
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudHealthcareV1ConsentGcsDestination
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -430,6 +454,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ImportMessagesRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ImportMessagesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ImportResourcesRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1138,6 +1174,22 @@ module Google
         end
       end
       
+      class ExportMessagesRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1::GcsDestination, decorator: Google::Apis::HealthcareV1::GcsDestination::Representation
+      
+          property :start_time, as: 'startTime'
+        end
+      end
+      
+      class ExportMessagesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class ExportResourcesRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1224,6 +1276,22 @@ module Google
         end
       end
       
+      class GcsDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :content_structure, as: 'contentStructure'
+          property :message_view, as: 'messageView'
+          property :uri_prefix, as: 'uriPrefix'
+        end
+      end
+      
+      class GcsSource
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :uri, as: 'uri'
+        end
+      end
+      
       class GoogleCloudHealthcareV1ConsentGcsDestination
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1390,6 +1458,20 @@ module Google
         end
       end
       
+      class ImportMessagesRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :gcs_source, as: 'gcsSource', class: Google::Apis::HealthcareV1::GcsSource, decorator: Google::Apis::HealthcareV1::GcsSource::Representation
+      
+        end
+      end
+      
+      class ImportMessagesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class ImportResourcesRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/healthcare_v1/service.rb

@@ -4455,6 +4455,46 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports the messages to a destination. To filter messages to be exported,
+        # define a filter using the start and end time, relative to the message
+        # generation time (MSH.7). This API returns an Operation that can be used to
+        # track the status of the job by calling GetOperation. Immediate fatal errors
+        # appear in the error field. Otherwise, when the operation finishes, a detailed
+        # response of type ExportMessagesResponse is returned in the response field. The
+        # metadata field type for this operation is OperationMetadata.
+        # @param [String] name
+        #   The name of the source HL7v2 store, in the format `projects/`project_id`/
+        #   locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
+        # @param [Google::Apis::HealthcareV1::ExportMessagesRequest] export_messages_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::HealthcareV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1::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_hl7_v2_store_messages(name, export_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:export', options)
+          command.request_representation = Google::Apis::HealthcareV1::ExportMessagesRequest::Representation
+          command.request_object = export_messages_request_object
+          command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
+          command.response_class = Google::Apis::HealthcareV1::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 HL7v2 store.
         # @param [String] name
         #   The resource name of the HL7v2 store to get.
@@ -4526,6 +4566,63 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Import messages to the HL7v2 store by loading data from the specified sources.
+        # This method is optimized to load large quantities of data using import
+        # semantics that ignore some HL7v2 store configuration options and are not
+        # suitable for all use cases. It is primarily intended to load data into an
+        # empty HL7v2 store that is not being used by other clients. An existing message
+        # will be overwritten if a duplicate message is imported. A duplicate message is
+        # a message with the same raw bytes as a message that already exists in this
+        # HL7v2 store. When a message is overwritten, its labels will also be
+        # overwritten. The import operation is idempotent unless the input data contains
+        # multiple valid messages with the same raw bytes but different labels. In that
+        # case, after the import completes, the store contains exactly one message with
+        # those raw bytes but there is no ordering guarantee on which version of the
+        # labels it has. The operation result counters do not count duplicated raw bytes
+        # as an error and count one success for each message in the input, which might
+        # result in a success count larger than the number of messages in the HL7v2
+        # store. If some messages fail to import, for example due to parsing errors,
+        # successfully imported messages are not rolled back. This method returns an
+        # Operation that can be used to track the status of the import by calling
+        # GetOperation. Immediate fatal errors appear in the error field, errors are
+        # also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https:/
+        # /cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the
+        # operation finishes, a response of type ImportMessagesResponse is returned in
+        # the response field. The metadata field type for this operation is
+        # OperationMetadata.
+        # @param [String] name
+        #   The name of the target HL7v2 store, in the format `projects/`project_id`/
+        #   locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
+        # @param [Google::Apis::HealthcareV1::ImportMessagesRequest] import_messages_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::HealthcareV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1::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_hl7_v2_store_messages(name, import_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:import', options)
+          command.request_representation = Google::Apis::HealthcareV1::ImportMessagesRequest::Representation
+          command.request_object = import_messages_request_object
+          command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
+          command.response_class = Google::Apis::HealthcareV1::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 HL7v2 stores in the given dataset.
         # @param [String] parent
         #   Name of the dataset.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-healthcare_v1
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-healthcare_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.14.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1/v0.15.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-healthcare_v1
 post_install_message: 
 rdoc_options: []