google-apis-healthcare_v1beta1 0.56.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f37f1ee250be74bd390d34084d90873153305f42d2ba87b185627b009e2c67bc
-  data.tar.gz: 69b6cd156f006d3b9703f930f3140a04df5f72af56a079afee10f038930d7e41
+  metadata.gz: ba7d681f27fa13025b4730435a6a5db3d6aff6b1687d4a116524200caa97a2bd
+  data.tar.gz: 5d241a85f6c800c62a5baa3b9ab24ea3c3e1121404fdc247e3622a23df5eb8d0
 SHA512:
-  metadata.gz: e9fbea24ada856115910f0a2763d78720b02d6ef56a186d5c1a7a278a739f0bb92a2b37551034f90da2343415a4a310ebec8dbb270d5fb4cee4cba8b9634857b
-  data.tar.gz: ec75c627cb6bfbed90124c3ada01f5a53ccd04c0a9485c48bf12b5c5250cc8f62f09822f19e76b7891cf5593a6e8f82639efaf2df3e84b77bd05e97e2b9fe75e
+  metadata.gz: 633734b41a30b249be124043d0fc3a9e6760fb41a5b221e2d0d0d93d66a93b0ab785f879c8c3eeead6337ab7ccb0006d5ebcc10d2abdeed9dc1a8249ee6d3ad6
+  data.tar.gz: 471eb764efe42a279bb297402e60979d15c4004873f69ee6bcf492a9b9c70dad2409d142d3be96559697875b2ae765cf34869cc53ec7774997e0c2531503e380

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-healthcare_v1beta1
 
+### v0.57.0 (2023-10-15)
+
+* Regenerated from discovery document revision 20231003
+
 ### v0.56.0 (2023-10-01)
 
 * Regenerated from discovery document revision 20230921

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

@@ -2005,6 +2005,56 @@ module Google
         end
       end
       
+      # DicomStoreMetrics contains metrics describing a DICOM store.
+      class DicomStoreMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Total blob storage bytes for all instances in the store.
+        # Corresponds to the JSON property `blobStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :blob_storage_size_bytes
+      
+        # Number of instances in the store.
+        # Corresponds to the JSON property `instanceCount`
+        # @return [Fixnum]
+        attr_accessor :instance_count
+      
+        # 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
+      
+        # Number of series in the store.
+        # Corresponds to the JSON property `seriesCount`
+        # @return [Fixnum]
+        attr_accessor :series_count
+      
+        # Total structured storage bytes for all instances in the store.
+        # Corresponds to the JSON property `structuredStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :structured_storage_size_bytes
+      
+        # Number of studies in the store.
+        # Corresponds to the JSON property `studyCount`
+        # @return [Fixnum]
+        attr_accessor :study_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @blob_storage_size_bytes = args[:blob_storage_size_bytes] if args.key?(:blob_storage_size_bytes)
+          @instance_count = args[:instance_count] if args.key?(:instance_count)
+          @name = args[:name] if args.key?(:name)
+          @series_count = args[:series_count] if args.key?(:series_count)
+          @structured_storage_size_bytes = args[:structured_storage_size_bytes] if args.key?(:structured_storage_size_bytes)
+          @study_count = args[:study_count] if args.key?(:study_count)
+        end
+      end
+      
       # Specifies the parameters needed for the de-identification of DICOM stores.
       class DicomTagConfig
         include Google::Apis::Core::Hashable
@@ -4073,6 +4123,64 @@ module Google
         end
       end
       
+      # Count of messages and total storage size by type for a given HL7 store.
+      class Hl7V2StoreMetric
+        include Google::Apis::Core::Hashable
+      
+        # The total count of HL7v2 messages in the store for the given message type.
+        # Corresponds to the JSON property `count`
+        # @return [Fixnum]
+        attr_accessor :count
+      
+        # The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`.
+        # Corresponds to the JSON property `messageType`
+        # @return [String]
+        attr_accessor :message_type
+      
+        # The total amount of structured storage used by HL7v2 messages of this message
+        # type in the store.
+        # Corresponds to the JSON property `structuredStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :structured_storage_size_bytes
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @count = args[:count] if args.key?(:count)
+          @message_type = args[:message_type] if args.key?(:message_type)
+          @structured_storage_size_bytes = args[:structured_storage_size_bytes] if args.key?(:structured_storage_size_bytes)
+        end
+      end
+      
+      # List of metrics for a given HL7v2 store.
+      class Hl7V2StoreMetrics
+        include Google::Apis::Core::Hashable
+      
+        # List of HL7v2 store metrics by message type.
+        # Corresponds to the JSON property `metrics`
+        # @return [Array<Google::Apis::HealthcareV1beta1::Hl7V2StoreMetric>]
+        attr_accessor :metrics
+      
+        # The resource name of the HL7v2 store to get metrics for, in the format `
+        # projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_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)
+          @metrics = args[:metrics] if args.key?(:metrics)
+          @name = args[:name] if args.key?(:name)
+        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
@@ -6199,6 +6307,45 @@ module Google
         end
       end
       
+      # SeriesMetrics contains metrics describing a DICOM series.
+      class SeriesMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Total blob storage bytes for all instances in the series.
+        # Corresponds to the JSON property `blobStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :blob_storage_size_bytes
+      
+        # Number of instances in the series.
+        # Corresponds to the JSON property `instanceCount`
+        # @return [Fixnum]
+        attr_accessor :instance_count
+      
+        # The series resource path. For example, `projects/`project_id`/locations/`
+        # location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
+        # studies/`study_uid`/series/`series_uid``.
+        # Corresponds to the JSON property `series`
+        # @return [String]
+        attr_accessor :series
+      
+        # Total structured storage bytes for all instances in the series.
+        # Corresponds to the JSON property `structuredStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :structured_storage_size_bytes
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @blob_storage_size_bytes = args[:blob_storage_size_bytes] if args.key?(:blob_storage_size_bytes)
+          @instance_count = args[:instance_count] if args.key?(:instance_count)
+          @series = args[:series] if args.key?(:series)
+          @structured_storage_size_bytes = args[:structured_storage_size_bytes] if args.key?(:structured_storage_size_bytes)
+        end
+      end
+      
       # Request message for `SetIamPolicy` method.
       class SetIamPolicyRequest
         include Google::Apis::Core::Hashable
@@ -6363,6 +6510,51 @@ module Google
         end
       end
       
+      # StudyMetrics contains metrics describing a DICOM study.
+      class StudyMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Total blob storage bytes for all instances in the study.
+        # Corresponds to the JSON property `blobStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :blob_storage_size_bytes
+      
+        # Number of instances in the study.
+        # Corresponds to the JSON property `instanceCount`
+        # @return [Fixnum]
+        attr_accessor :instance_count
+      
+        # Number of series in the study.
+        # Corresponds to the JSON property `seriesCount`
+        # @return [Fixnum]
+        attr_accessor :series_count
+      
+        # Total structured storage bytes for all instances in the study.
+        # Corresponds to the JSON property `structuredStorageSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :structured_storage_size_bytes
+      
+        # The study resource path. For example, `projects/`project_id`/locations/`
+        # location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
+        # studies/`study_uid``.
+        # Corresponds to the JSON property `study`
+        # @return [String]
+        attr_accessor :study
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @blob_storage_size_bytes = args[:blob_storage_size_bytes] if args.key?(:blob_storage_size_bytes)
+          @instance_count = args[:instance_count] if args.key?(:instance_count)
+          @series_count = args[:series_count] if args.key?(:series_count)
+          @structured_storage_size_bytes = args[:structured_storage_size_bytes] if args.key?(:structured_storage_size_bytes)
+          @study = args[:study] if args.key?(:study)
+        end
+      end
+      
       # List of tags to be filtered.
       class TagFilterList
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module HealthcareV1beta1
       # Version of the google-apis-healthcare_v1beta1 gem
-      GEM_VERSION = "0.56.0"
+      GEM_VERSION = "0.57.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230921"
+      REVISION = "20231003"
     end
   end
 end

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

@@ -376,6 +376,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class DicomStoreMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class DicomTagConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -706,6 +712,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Hl7V2StoreMetric
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Hl7V2StoreMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class HttpBody
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1138,6 +1156,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class SeriesMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class SetIamPolicyRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1162,6 +1186,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class StudyMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class TagFilterList
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1786,6 +1816,18 @@ module Google
         end
       end
       
+      class DicomStoreMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :blob_storage_size_bytes, :numeric_string => true, as: 'blobStorageSizeBytes'
+          property :instance_count, :numeric_string => true, as: 'instanceCount'
+          property :name, as: 'name'
+          property :series_count, :numeric_string => true, as: 'seriesCount'
+          property :structured_storage_size_bytes, :numeric_string => true, as: 'structuredStorageSizeBytes'
+          property :study_count, :numeric_string => true, as: 'studyCount'
+        end
+      end
+      
       class DicomTagConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2317,6 +2359,24 @@ module Google
         end
       end
       
+      class Hl7V2StoreMetric
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :count, :numeric_string => true, as: 'count'
+          property :message_type, as: 'messageType'
+          property :structured_storage_size_bytes, :numeric_string => true, as: 'structuredStorageSizeBytes'
+        end
+      end
+      
+      class Hl7V2StoreMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :metrics, as: 'metrics', class: Google::Apis::HealthcareV1beta1::Hl7V2StoreMetric, decorator: Google::Apis::HealthcareV1beta1::Hl7V2StoreMetric::Representation
+      
+          property :name, as: 'name'
+        end
+      end
+      
       class HttpBody
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2943,6 +3003,16 @@ module Google
         end
       end
       
+      class SeriesMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :blob_storage_size_bytes, :numeric_string => true, as: 'blobStorageSizeBytes'
+          property :instance_count, :numeric_string => true, as: 'instanceCount'
+          property :series, as: 'series'
+          property :structured_storage_size_bytes, :numeric_string => true, as: 'structuredStorageSizeBytes'
+        end
+      end
+      
       class SetIamPolicyRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2983,6 +3053,17 @@ module Google
         end
       end
       
+      class StudyMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :blob_storage_size_bytes, :numeric_string => true, as: 'blobStorageSizeBytes'
+          property :instance_count, :numeric_string => true, as: 'instanceCount'
+          property :series_count, :numeric_string => true, as: 'seriesCount'
+          property :structured_storage_size_bytes, :numeric_string => true, as: 'structuredStorageSizeBytes'
+          property :study, as: 'study'
+        end
+      end
+      
       class TagFilterList
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -2747,6 +2747,36 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets metrics associated with the DICOM store.
+        # @param [String] name
+        #   The resource name of the DICOM store to get metrics 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::HealthcareV1beta1::DicomStoreMetrics] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::DicomStoreMetrics]
+        #
+        # @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_dicom_store_metrics(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}:getDICOMStoreMetrics', options)
+          command.response_representation = Google::Apis::HealthcareV1beta1::DicomStoreMetrics::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::DicomStoreMetrics
+          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
@@ -3182,6 +3212,70 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # GetStudyMetrics returns metrics for a study.
+        # @param [String] study
+        #   The study resource path. For example, `projects/`project_id`/locations/`
+        #   location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
+        #   studies/`study_uid``.
+        # @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::HealthcareV1beta1::StudyMetrics] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::StudyMetrics]
+        #
+        # @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_dicom_web_study_study_metrics(study, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+study}:getStudyMetrics', options)
+          command.response_representation = Google::Apis::HealthcareV1beta1::StudyMetrics::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::StudyMetrics
+          command.params['study'] = study unless study.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # GetSeriesMetrics returns metrics for a series.
+        # @param [String] series
+        #   The series resource path. For example, `projects/`project_id`/locations/`
+        #   location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
+        #   studies/`study_uid`/series/`series_uid``.
+        # @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::HealthcareV1beta1::SeriesMetrics] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::SeriesMetrics]
+        #
+        # @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_dicom_web_study_series_series_metrics(series, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+series}:getSeriesMetrics', options)
+          command.response_representation = Google::Apis::HealthcareV1beta1::SeriesMetrics::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::SeriesMetrics
+          command.params['series'] = series unless series.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 using a long running
         # operation. The method returns an Operation which will be marked successful
         # when the deletion is complete. Warning: Instances cannot be inserted into a
@@ -5963,6 +6057,38 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets metrics asssociated with the HL7v2 store.
+        # @param [String] name
+        #   The resource name of the HL7v2 store to get metrics for, in the format `
+        #   projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+        #   hl7V2Stores/`hl7v2_store_id``.
+        # @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::HealthcareV1beta1::Hl7V2StoreMetrics] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::Hl7V2StoreMetrics]
+        #
+        # @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_hl7v2_store_metrics(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+name}:getHL7v2StoreMetrics', options)
+          command.response_representation = Google::Apis::HealthcareV1beta1::Hl7V2StoreMetrics::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::Hl7V2StoreMetrics
+          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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-healthcare_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.56.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-10-15 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/main/generated/google-apis-healthcare_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.56.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-healthcare_v1beta1/v0.57.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-healthcare_v1beta1
 post_install_message: 
 rdoc_options: []