diff --git a/api_names_out.yaml b/api_names_out.yaml index 37414e2ae..5c9b24c3d 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -99960,7 +99960,13 @@ "/documentai:v1beta2/fields": fields "/documentai:v1beta2/key": key "/documentai:v1beta2/quotaUser": quota_user +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": google_cloud_documentai_uiv1beta3_common_operation_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata/createTime": create_time +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata/state": state +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata/stateMessage": state_message +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": google_cloud_documentai_uiv1beta3_create_labeler_pool_operation_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata/stateMessage": state_message @@ -99970,28 +99976,43 @@ "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": google_cloud_documentai_uiv1beta3_delete_labeler_pool_operation_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata/stateMessage": state_message "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": google_cloud_documentai_uiv1beta3_delete_processor_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata/stateMessage": state_message "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata/updateTime": update_time +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_delete_processor_version_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata/commonMetadata": common_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_deploy_processor_version_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata/commonMetadata": common_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse": google_cloud_documentai_uiv1beta3_deploy_processor_version_response "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": google_cloud_documentai_uiv1beta3_disable_processor_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata/stateMessage": state_message "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse": google_cloud_documentai_uiv1beta3_disable_processor_response "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": google_cloud_documentai_uiv1beta3_enable_processor_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/stateMessage": state_message "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata/updateTime": update_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": google_cloud_documentai_uiv1beta3_enable_processor_response +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": google_cloud_documentai_uiv1beta3_undeploy_processor_version_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata/commonMetadata": common_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": google_cloud_documentai_uiv1beta3_undeploy_processor_version_response +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": google_cloud_documentai_uiv1beta3_update_human_review_config_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": google_cloud_documentai_uiv1beta3_update_labeler_pool_operation_metadata +"/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/commonMetadata": common_metadata "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/createTime": create_time "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/state": state "/documentai:v1beta3/GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata/stateMessage": state_message @@ -100806,6 +100827,10 @@ "/documentai:v1beta3/documentai.projects.locations.processors.humanReviewConfig.reviewDocument/humanReviewConfig": human_review_config "/documentai:v1beta3/documentai.projects.locations.processors.process": process_project_location_processor "/documentai:v1beta3/documentai.projects.locations.processors.process/name": name +"/documentai:v1beta3/documentai.projects.locations.processors.processorVersions.batchProcess": batch_project_location_processor_processor_version_process +"/documentai:v1beta3/documentai.projects.locations.processors.processorVersions.batchProcess/name": name +"/documentai:v1beta3/documentai.projects.locations.processors.processorVersions.process": process_project_location_processor_processor_version +"/documentai:v1beta3/documentai.projects.locations.processors.processorVersions.process/name": name "/documentai:v1beta3/fields": fields "/documentai:v1beta3/key": key "/documentai:v1beta3/quotaUser": quota_user diff --git a/generated/google/apis/documentai_v1beta3.rb b/generated/google/apis/documentai_v1beta3.rb index 232495cd0..1a8ae8a99 100644 --- a/generated/google/apis/documentai_v1beta3.rb +++ b/generated/google/apis/documentai_v1beta3.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/document-ai/docs/ module DocumentaiV1beta3 VERSION = 'V1beta3' - REVISION = '20200828' + REVISION = '20201207' # 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/documentai_v1beta3/classes.rb b/generated/google/apis/documentai_v1beta3/classes.rb index 139d12f1a..0889f00a9 100644 --- a/generated/google/apis/documentai_v1beta3/classes.rb +++ b/generated/google/apis/documentai_v1beta3/classes.rb @@ -22,8 +22,8 @@ module Google module Apis module DocumentaiV1beta3 - # The long running operation metadata for CreateLabelerPool. - class GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + # The common metadata for long running operations. + class GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata include Google::Apis::Core::Hashable # The creation time of the operation. @@ -31,13 +31,12 @@ module Google # @return [String] attr_accessor :create_time - # Used only when Operation.done is false. + # The state of the operation. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # A message providing more details about the current state of processing. For - # example, the error message if the operation is failed. + # A message providing more details about the current state of processing. # Corresponds to the JSON property `stateMessage` # @return [String] attr_accessor :state_message @@ -60,6 +59,25 @@ module Google end end + # The long running operation metadata for CreateLabelerPool. + class GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + # The metadata that represents a processor version being created. class GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata include Google::Apis::Core::Hashable @@ -95,26 +113,10 @@ module Google class GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata include Google::Apis::Core::Hashable - # The creation time of the operation. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Used only when Operation.done is false. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # A message providing more details about the current state of processing. For - # example, the error message if the operation is failed. - # Corresponds to the JSON property `stateMessage` - # @return [String] - attr_accessor :state_message - - # The last update time of the operation. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata def initialize(**args) update!(**args) @@ -122,10 +124,7 @@ module Google # Update properties of this object def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @state = args[:state] if args.key?(:state) - @state_message = args[:state_message] if args.key?(:state_message) - @update_time = args[:update_time] if args.key?(:update_time) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) end end @@ -133,6 +132,11 @@ module Google class GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata include Google::Apis::Core::Hashable + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + # The creation time of the operation. # Corresponds to the JSON property `createTime` # @return [String] @@ -160,6 +164,7 @@ module Google # Update properties of this object def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) @create_time = args[:create_time] if args.key?(:create_time) @state = args[:state] if args.key?(:state) @state_message = args[:state_message] if args.key?(:state_message) @@ -167,10 +172,66 @@ module Google end end + # The long running operation metadata for delete processor version method. + class GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # The long running operation metadata for deploy processor version method. + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # Response message for the deploy processor version method. + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # The long running operation metadata for disable processor method. class GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata include Google::Apis::Core::Hashable + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + # The creation time of the operation. # Corresponds to the JSON property `createTime` # @return [String] @@ -198,6 +259,7 @@ module Google # Update properties of this object def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) @create_time = args[:create_time] if args.key?(:create_time) @state = args[:state] if args.key?(:state) @state_message = args[:state_message] if args.key?(:state_message) @@ -223,6 +285,11 @@ module Google class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata include Google::Apis::Core::Hashable + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + # The creation time of the operation. # Corresponds to the JSON property `createTime` # @return [String] @@ -250,6 +317,7 @@ module Google # Update properties of this object def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) @create_time = args[:create_time] if args.key?(:create_time) @state = args[:state] if args.key?(:state) @state_message = args[:state_message] if args.key?(:state_message) @@ -271,30 +339,14 @@ module Google end end - # The long running operation metadata for UpdateLabelerPool. - class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata + # The long running operation metadata for the undeploy processor version method. + class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata include Google::Apis::Core::Hashable - # The creation time of the operation. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Used only when Operation.done is false. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # A message providing more details about the current state of processing. For - # example, the error message if the operation is failed. - # Corresponds to the JSON property `stateMessage` - # @return [String] - attr_accessor :state_message - - # The last update time of the operation. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata def initialize(**args) update!(**args) @@ -302,10 +354,59 @@ module Google # Update properties of this object def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @state = args[:state] if args.key?(:state) - @state_message = args[:state_message] if args.key?(:state_message) - @update_time = args[:update_time] if args.key?(:update_time) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # Response message for the undeploy processor version method. + class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The long running operation metadata for updating the human review + # configuration. + class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) + end + end + + # The long running operation metadata for UpdateLabelerPool. + class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata + include Google::Apis::Core::Hashable + + # The common metadata for long running operations. + # Corresponds to the JSON property `commonMetadata` + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata] + attr_accessor :common_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @common_metadata = args[:common_metadata] if args.key?(:common_metadata) end end @@ -570,27 +671,32 @@ module Google # @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress] attr_accessor :address_value - # Represents a whole or partial calendar date, e.g. a birthday. The time of day - # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: * A full - # date, with non-zero year, month and day values * A month and day value, with a - # zero year, e.g. an anniversary * A year on its own, with zero month and day - # values * A year and month value, with a zero day, e.g. a credit card - # expiration date Related types are google.type.TimeOfDay and `google.protobuf. - # Timestamp`. + # Represents a whole or partial calendar date, such as a birthday. The time of + # day and time zone are either specified elsewhere or are insignificant. The + # date is relative to the Gregorian Calendar. This can represent one of the + # following: * A full date, with non-zero year, month, and day values * A month + # and day value, with a zero year, such as an anniversary * A year on its own, + # with zero month and day values * A year and month value, with a zero day, such + # as a credit card expiration date Related types are google.type.TimeOfDay and ` + # google.protobuf.Timestamp`. # Corresponds to the JSON property `dateValue` # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDate] attr_accessor :date_value - # Represents civil time in one of a few possible ways: * When utc_offset is set - # and time_zone is unset: a civil time on a calendar day with a particular - # offset from UTC. * When time_zone is set and utc_offset is unset: a civil time - # on a calendar day in a particular time zone. * When neither time_zone nor + # Represents civil time (or occasionally physical time). This type can represent + # a civil time in one of a few possible ways: * When utc_offset is set and + # time_zone is unset: a civil time on a calendar day with a particular offset + # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a + # calendar day in a particular time zone. * When neither time_zone nor # utc_offset is set: a civil time on a calendar day in local time. The date is # relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is # considered not to have a specific year. month and day must have valid, non- - # zero values. This type is more flexible than some applications may want. Make - # sure to document and validate your application's limitations. + # zero values. This type may also be used to represent a physical time if all + # the date and time fields are set and either case of the `time_offset` oneof is + # set. Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in another + # field. This type is more flexible than some applications may want. Make sure + # to document and validate your application's limitations. # Corresponds to the JSON property `datetimeValue` # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDateTime] attr_accessor :datetime_value @@ -793,7 +899,8 @@ module Google # @return [String] attr_accessor :layout_type - # Required. Index into the Document.pages element + # Required. Index into the Document.pages element, for example using Document. + # pages to locate the related page element. # Corresponds to the JSON property `page` # @return [Fixnum] attr_accessor :page @@ -2260,27 +2367,32 @@ module Google # @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress] attr_accessor :address_value - # Represents a whole or partial calendar date, e.g. a birthday. The time of day - # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: * A full - # date, with non-zero year, month and day values * A month and day value, with a - # zero year, e.g. an anniversary * A year on its own, with zero month and day - # values * A year and month value, with a zero day, e.g. a credit card - # expiration date Related types are google.type.TimeOfDay and `google.protobuf. - # Timestamp`. + # Represents a whole or partial calendar date, such as a birthday. The time of + # day and time zone are either specified elsewhere or are insignificant. The + # date is relative to the Gregorian Calendar. This can represent one of the + # following: * A full date, with non-zero year, month, and day values * A month + # and day value, with a zero year, such as an anniversary * A year on its own, + # with zero month and day values * A year and month value, with a zero day, such + # as a credit card expiration date Related types are google.type.TimeOfDay and ` + # google.protobuf.Timestamp`. # Corresponds to the JSON property `dateValue` # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDate] attr_accessor :date_value - # Represents civil time in one of a few possible ways: * When utc_offset is set - # and time_zone is unset: a civil time on a calendar day with a particular - # offset from UTC. * When time_zone is set and utc_offset is unset: a civil time - # on a calendar day in a particular time zone. * When neither time_zone nor + # Represents civil time (or occasionally physical time). This type can represent + # a civil time in one of a few possible ways: * When utc_offset is set and + # time_zone is unset: a civil time on a calendar day with a particular offset + # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a + # calendar day in a particular time zone. * When neither time_zone nor # utc_offset is set: a civil time on a calendar day in local time. The date is # relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is # considered not to have a specific year. month and day must have valid, non- - # zero values. This type is more flexible than some applications may want. Make - # sure to document and validate your application's limitations. + # zero values. This type may also be used to represent a physical time if all + # the date and time fields are set and either case of the `time_offset` oneof is + # set. Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in another + # field. This type is more flexible than some applications may want. Make sure + # to document and validate your application's limitations. # Corresponds to the JSON property `datetimeValue` # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDateTime] attr_accessor :datetime_value @@ -2520,7 +2632,8 @@ module Google # @return [String] attr_accessor :layout_type - # Required. Index into the Document.pages element + # Required. Index into the Document.pages element, for example using Document. + # pages to locate the related page element. # Corresponds to the JSON property `page` # @return [Fixnum] attr_accessor :page @@ -4148,27 +4261,32 @@ module Google # @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress] attr_accessor :address_value - # Represents a whole or partial calendar date, e.g. a birthday. The time of day - # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: * A full - # date, with non-zero year, month and day values * A month and day value, with a - # zero year, e.g. an anniversary * A year on its own, with zero month and day - # values * A year and month value, with a zero day, e.g. a credit card - # expiration date Related types are google.type.TimeOfDay and `google.protobuf. - # Timestamp`. + # Represents a whole or partial calendar date, such as a birthday. The time of + # day and time zone are either specified elsewhere or are insignificant. The + # date is relative to the Gregorian Calendar. This can represent one of the + # following: * A full date, with non-zero year, month, and day values * A month + # and day value, with a zero year, such as an anniversary * A year on its own, + # with zero month and day values * A year and month value, with a zero day, such + # as a credit card expiration date Related types are google.type.TimeOfDay and ` + # google.protobuf.Timestamp`. # Corresponds to the JSON property `dateValue` # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDate] attr_accessor :date_value - # Represents civil time in one of a few possible ways: * When utc_offset is set - # and time_zone is unset: a civil time on a calendar day with a particular - # offset from UTC. * When time_zone is set and utc_offset is unset: a civil time - # on a calendar day in a particular time zone. * When neither time_zone nor + # Represents civil time (or occasionally physical time). This type can represent + # a civil time in one of a few possible ways: * When utc_offset is set and + # time_zone is unset: a civil time on a calendar day with a particular offset + # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a + # calendar day in a particular time zone. * When neither time_zone nor # utc_offset is set: a civil time on a calendar day in local time. The date is # relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is # considered not to have a specific year. month and day must have valid, non- - # zero values. This type is more flexible than some applications may want. Make - # sure to document and validate your application's limitations. + # zero values. This type may also be used to represent a physical time if all + # the date and time fields are set and either case of the `time_offset` oneof is + # set. Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in another + # field. This type is more flexible than some applications may want. Make sure + # to document and validate your application's limitations. # Corresponds to the JSON property `datetimeValue` # @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDateTime] attr_accessor :datetime_value @@ -4371,7 +4489,8 @@ module Google # @return [String] attr_accessor :layout_type - # Required. Index into the Document.pages element + # Required. Index into the Document.pages element, for example using Document. + # pages to locate the related page element. # Corresponds to the JSON property `page` # @return [Fixnum] attr_accessor :page @@ -5829,31 +5948,31 @@ module Google end end - # Represents a whole or partial calendar date, e.g. a birthday. The time of day - # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: * A full - # date, with non-zero year, month and day values * A month and day value, with a - # zero year, e.g. an anniversary * A year on its own, with zero month and day - # values * A year and month value, with a zero day, e.g. a credit card - # expiration date Related types are google.type.TimeOfDay and `google.protobuf. - # Timestamp`. + # Represents a whole or partial calendar date, such as a birthday. The time of + # day and time zone are either specified elsewhere or are insignificant. The + # date is relative to the Gregorian Calendar. This can represent one of the + # following: * A full date, with non-zero year, month, and day values * A month + # and day value, with a zero year, such as an anniversary * A year on its own, + # with zero month and day values * A year and month value, with a zero day, such + # as a credit card expiration date Related types are google.type.TimeOfDay and ` + # google.protobuf.Timestamp`. class GoogleTypeDate include Google::Apis::Core::Hashable - # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if - # specifying a year by itself or a year and month where the day is not - # significant. + # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to + # specify a year by itself or a year and month where the day isn't significant. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day - # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month # and day. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month - # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a + # year. # Corresponds to the JSON property `year` # @return [Fixnum] attr_accessor :year @@ -5870,15 +5989,20 @@ module Google end end - # Represents civil time in one of a few possible ways: * When utc_offset is set - # and time_zone is unset: a civil time on a calendar day with a particular - # offset from UTC. * When time_zone is set and utc_offset is unset: a civil time - # on a calendar day in a particular time zone. * When neither time_zone nor + # Represents civil time (or occasionally physical time). This type can represent + # a civil time in one of a few possible ways: * When utc_offset is set and + # time_zone is unset: a civil time on a calendar day with a particular offset + # from UTC. * When time_zone is set and utc_offset is unset: a civil time on a + # calendar day in a particular time zone. * When neither time_zone nor # utc_offset is set: a civil time on a calendar day in local time. The date is # relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is # considered not to have a specific year. month and day must have valid, non- - # zero values. This type is more flexible than some applications may want. Make - # sure to document and validate your application's limitations. + # zero values. This type may also be used to represent a physical time if all + # the date and time fields are set and either case of the `time_offset` oneof is + # set. Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in another + # field. This type is more flexible than some applications may want. Make sure + # to document and validate your application's limitations. class GoogleTypeDateTime include Google::Apis::Core::Hashable @@ -5954,7 +6078,7 @@ module Google class GoogleTypeMoney include Google::Apis::Core::Hashable - # The 3-letter currency code defined in ISO 4217. + # The three-letter currency code defined in ISO 4217. # Corresponds to the JSON property `currencyCode` # @return [String] attr_accessor :currency_code diff --git a/generated/google/apis/documentai_v1beta3/representations.rb b/generated/google/apis/documentai_v1beta3/representations.rb index 418aaeb66..39bef07f7 100644 --- a/generated/google/apis/documentai_v1beta3/representations.rb +++ b/generated/google/apis/documentai_v1beta3/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module DocumentaiV1beta3 + class GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -46,6 +52,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -70,6 +94,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -946,7 +988,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + class GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' @@ -956,6 +998,14 @@ module Google end end + class GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + class GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -968,16 +1018,16 @@ module Google class GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :state, as: 'state' - property :state_message, as: 'stateMessage' - property :update_time, as: 'updateTime' + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + end end class GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + property :create_time, as: 'createTime' property :state, as: 'state' property :state_message, as: 'stateMessage' @@ -985,9 +1035,33 @@ module Google end end + class GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + property :create_time, as: 'createTime' property :state, as: 'state' property :state_message, as: 'stateMessage' @@ -1004,6 +1078,8 @@ module Google class GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + property :create_time, as: 'createTime' property :state, as: 'state' property :state_message, as: 'stateMessage' @@ -1017,13 +1093,33 @@ module Google end end + class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + + class GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + + end + end + class GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :state, as: 'state' - property :state_message, as: 'stateMessage' - property :update_time, as: 'updateTime' + property :common_metadata, as: 'commonMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata::Representation + end end diff --git a/generated/google/apis/documentai_v1beta3/service.rb b/generated/google/apis/documentai_v1beta3/service.rb index f7d016f07..dc6b2218d 100644 --- a/generated/google/apis/documentai_v1beta3/service.rb +++ b/generated/google/apis/documentai_v1beta3/service.rb @@ -152,7 +152,9 @@ module Google # LRO endpoint to batch process many documents. The output is written to Cloud # Storage as JSON in the [Document] format. # @param [String] name - # Required. The processor resource name. + # Required. The resource name of Processor or ProcessorVersion. Format: projects/ + # `project`/locations/`location`/processors/`processor`, or projects/`project`/ + # locations/`location`/processors/`processor`/processorVerions/`processorVersion` # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -185,7 +187,11 @@ module Google # Processes a single document. # @param [String] name - # Required. The processor resource name. + # Required. The resource name of the Processor or ProcessorVersion to use for + # processing. If a Processor is specified, the server will use its default + # version. Format: projects/`project`/locations/`location`/processors/`processor` + # , or projects/`project`/locations/`location`/processors/`processor`/ + # processorVerions/`processorVersion` # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -250,6 +256,79 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # LRO endpoint to batch process many documents. The output is written to Cloud + # Storage as JSON in the [Document] format. + # @param [String] name + # Required. The resource name of Processor or ProcessorVersion. Format: projects/ + # `project`/locations/`location`/processors/`processor`, or projects/`project`/ + # locations/`location`/processors/`processor`/processorVerions/`processorVersion` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_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::DocumentaiV1beta3::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation] + # + # @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 batch_project_location_processor_processor_version_process(name, google_cloud_documentai_v1beta3_batch_process_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta3/{+name}:batchProcess', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest::Representation + command.request_object = google_cloud_documentai_v1beta3_batch_process_request_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleLongrunningOperation + 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 + + # Processes a single document. + # @param [String] name + # Required. The resource name of the Processor or ProcessorVersion to use for + # processing. If a Processor is specified, the server will use its default + # version. Format: projects/`project`/locations/`location`/processors/`processor` + # , or projects/`project`/locations/`location`/processors/`processor`/ + # processorVerions/`processorVersion` + # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_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::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessResponse] + # + # @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 process_project_location_processor_processor_version(name, google_cloud_documentai_v1beta3_process_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta3/{+name}:process', options) + command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest::Representation + command.request_object = google_cloud_documentai_v1beta3_process_request_object + command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessResponse::Representation + command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessResponse + 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 protected diff --git a/generated/google/apis/documentai_v1beta3/synth.metadata b/generated/google/apis/documentai_v1beta3/synth.metadata index 429012f74..50563865c 100644 --- a/generated/google/apis/documentai_v1beta3/synth.metadata +++ b/generated/google/apis/documentai_v1beta3/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "c98c719bbab68d0890524d53f8b629d7858af9c2" + "sha": "9e7a0a144fbc0bdef5ebd548056e511ebafbdee8" } } ]