From 2068ba54f4826f8b5d28839e94c4bbf661e3da4e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 26 Apr 2023 16:08:24 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#1961) --- admin/directory/v1/admin-api.json | 4 +- admin/directory/v1/admin-gen.go | 9 +- admob/v1/admob-api.json | 4 +- admob/v1/admob-gen.go | 3 +- admob/v1beta/admob-api.json | 4 +- admob/v1beta/admob-gen.go | 3 +- androidpublisher/v3/androidpublisher-api.json | 4 +- androidpublisher/v3/androidpublisher-gen.go | 6 +- apigee/v1/apigee-api.json | 4 +- apigee/v1/apigee-gen.go | 4 +- assuredworkloads/v1/assuredworkloads-api.json | 32 +- assuredworkloads/v1/assuredworkloads-gen.go | 44 +- .../v1beta1/assuredworkloads-api.json | 70 ++- .../v1beta1/assuredworkloads-gen.go | 111 ++-- chat/v1/chat-api.json | 4 +- chat/v1/chat-gen.go | 7 +- datacatalog/v1/datacatalog-api.json | 4 +- datacatalog/v1/datacatalog-gen.go | 2 +- datacatalog/v1beta1/datacatalog-api.json | 4 +- datacatalog/v1beta1/datacatalog-gen.go | 2 +- .../v1alpha/discoveryengine-api.json | 85 ++- .../v1alpha/discoveryengine-gen.go | 351 ++++++++--- .../v1beta/discoveryengine-api.json | 85 ++- discoveryengine/v1beta/discoveryengine-gen.go | 351 ++++++++--- documentai/v1/documentai-api.json | 405 ++++++++++--- documentai/v1/documentai-gen.go | 524 +++++++++++++---- documentai/v1beta2/documentai-api.json | 314 +++++++--- documentai/v1beta2/documentai-gen.go | 395 +++++++++---- documentai/v1beta3/documentai-api.json | 415 ++++++++++--- documentai/v1beta3/documentai-gen.go | 551 +++++++++++++----- fcm/v1/fcm-api.json | 18 +- fcm/v1/fcm-gen.go | 12 + healthcare/v1/healthcare-api.json | 30 +- healthcare/v1/healthcare-gen.go | 74 ++- healthcare/v1beta1/healthcare-api.json | 10 +- healthcare/v1beta1/healthcare-gen.go | 40 +- language/v1/language-api.json | 4 +- language/v1/language-gen.go | 4 +- language/v1beta2/language-api.json | 6 +- language/v1beta2/language-gen.go | 6 +- redis/v1/redis-api.json | 4 +- redis/v1/redis-gen.go | 2 +- 42 files changed, 2945 insertions(+), 1066 deletions(-) diff --git a/admin/directory/v1/admin-api.json b/admin/directory/v1/admin-api.json index a6dad8e6931..f348c5088ec 100644 --- a/admin/directory/v1/admin-api.json +++ b/admin/directory/v1/admin-api.json @@ -4635,7 +4635,7 @@ } } }, - "revision": "20230406", + "revision": "20230425", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6770,7 +6770,7 @@ "id": "OrgUnit", "properties": { "blockInheritance": { - "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).", + "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. We recommend using the default value because setting `block_inheritance` to `true` can have _unintended consequences_. For more information about inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).", "type": "boolean" }, "description": { diff --git a/admin/directory/v1/admin-gen.go b/admin/directory/v1/admin-gen.go index 73df954e3c5..33928c7f0ac 100644 --- a/admin/directory/v1/admin-gen.go +++ b/admin/directory/v1/admin-gen.go @@ -3990,10 +3990,11 @@ type OrgUnit struct { // BlockInheritance: Determines if a sub-organizational unit can inherit // the settings of the parent organization. The default value is // `false`, meaning a sub-organizational unit inherits the settings of - // the nearest parent organizational unit. For more information on - // inheritance and users in an organization structure, see the - // administration help center - // (https://support.google.com/a/answer/4352075). + // the nearest parent organizational unit. We recommend using the + // default value because setting `block_inheritance` to `true` can have + // _unintended consequences_. For more information about inheritance and + // users in an organization structure, see the administration help + // center (https://support.google.com/a/answer/4352075). BlockInheritance bool `json:"blockInheritance,omitempty"` // Description: Description of the organizational unit. diff --git a/admob/v1/admob-api.json b/admob/v1/admob-api.json index d1491641926..0c35580e286 100644 --- a/admob/v1/admob-api.json +++ b/admob/v1/admob-api.json @@ -321,7 +321,7 @@ } } }, - "revision": "20230330", + "revision": "20230425", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { @@ -363,7 +363,7 @@ "id": "App", "properties": { "appApprovalState": { - "description": "Output only. The approval state for the app.", + "description": "Output only. The approval state for the app. The field is read-only.", "enum": [ "APP_APPROVAL_STATE_UNSPECIFIED", "ACTION_REQUIRED", diff --git a/admob/v1/admob-gen.go b/admob/v1/admob-gen.go index 04383d30436..b0f3849124c 100644 --- a/admob/v1/admob-gen.go +++ b/admob/v1/admob-gen.go @@ -268,7 +268,8 @@ func (s *AdUnit) MarshalJSON() ([]byte, error) { // App: Describes an AdMob app for a specific platform (For example: // Android or iOS). type App struct { - // AppApprovalState: Output only. The approval state for the app. + // AppApprovalState: Output only. The approval state for the app. The + // field is read-only. // // Possible values: // "APP_APPROVAL_STATE_UNSPECIFIED" - Default value for an unset diff --git a/admob/v1beta/admob-api.json b/admob/v1beta/admob-api.json index 760edede70c..065d8dd1627 100644 --- a/admob/v1beta/admob-api.json +++ b/admob/v1beta/admob-api.json @@ -359,7 +359,7 @@ } } }, - "revision": "20230330", + "revision": "20230425", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { @@ -420,7 +420,7 @@ "id": "App", "properties": { "appApprovalState": { - "description": "Output only. The approval state for the app.", + "description": "Output only. The approval state for the app. The field is read-only.", "enum": [ "APP_APPROVAL_STATE_UNSPECIFIED", "ACTION_REQUIRED", diff --git a/admob/v1beta/admob-gen.go b/admob/v1beta/admob-gen.go index 71f35626305..058242600dd 100644 --- a/admob/v1beta/admob-gen.go +++ b/admob/v1beta/admob-gen.go @@ -315,7 +315,8 @@ func (s *AdUnit) MarshalJSON() ([]byte, error) { // App: Describes an AdMob app for a specific platform (For example: // Android or iOS). type App struct { - // AppApprovalState: Output only. The approval state for the app. + // AppApprovalState: Output only. The approval state for the app. The + // field is read-only. // // Possible values: // "APP_APPROVAL_STATE_UNSPECIFIED" - Default value for an unset diff --git a/androidpublisher/v3/androidpublisher-api.json b/androidpublisher/v3/androidpublisher-api.json index 436413f98d1..bbaacfd85f5 100644 --- a/androidpublisher/v3/androidpublisher-api.json +++ b/androidpublisher/v3/androidpublisher-api.json @@ -1856,7 +1856,7 @@ ], "parameters": { "externalTransactionId": { - "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/.", + "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked.", "location": "query", "type": "string" }, @@ -4045,7 +4045,7 @@ } } }, - "revision": "20230418", + "revision": "20230425", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "AcquisitionTargetingRule": { diff --git a/androidpublisher/v3/androidpublisher-gen.go b/androidpublisher/v3/androidpublisher-gen.go index 4e7e922b8fc..8dd96ee7017 100644 --- a/androidpublisher/v3/androidpublisher-gen.go +++ b/androidpublisher/v3/androidpublisher-gen.go @@ -13141,7 +13141,9 @@ func (r *ExternaltransactionsService) Createexternaltransaction(parent string, e // "externalTransactionId": Required. The id to use for the external // transaction. Must be unique across all other transactions for the // app. This value should be 1-63 characters and valid characters are -// /a-z0-9_-/. +// /a-z0-9_-/. Do not use this field to store any Personally +// Identifiable Information (PII) such as emails. Attempting to store +// PII in this field may result in requests being blocked. func (c *ExternaltransactionsCreateexternaltransactionCall) ExternalTransactionId(externalTransactionId string) *ExternaltransactionsCreateexternaltransactionCall { c.urlParams_.Set("externalTransactionId", externalTransactionId) return c @@ -13247,7 +13249,7 @@ func (c *ExternaltransactionsCreateexternaltransactionCall) Do(opts ...googleapi // ], // "parameters": { // "externalTransactionId": { - // "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/.", + // "description": "Required. The id to use for the external transaction. Must be unique across all other transactions for the app. This value should be 1-63 characters and valid characters are /a-z0-9_-/. Do not use this field to store any Personally Identifiable Information (PII) such as emails. Attempting to store PII in this field may result in requests being blocked.", // "location": "query", // "type": "string" // }, diff --git a/apigee/v1/apigee-api.json b/apigee/v1/apigee-api.json index 676536aff1a..92c7d2f1c96 100644 --- a/apigee/v1/apigee-api.json +++ b/apigee/v1/apigee-api.json @@ -4164,7 +4164,7 @@ "type": "boolean" }, "sequencedRollout": { - "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", + "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [generateDeployChangeReport API](generateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", "location": "query", "type": "boolean" }, @@ -8744,7 +8744,7 @@ } } }, - "revision": "20230410", + "revision": "20230421", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { diff --git a/apigee/v1/apigee-gen.go b/apigee/v1/apigee-gen.go index 9c507803110..128bd7b38b0 100644 --- a/apigee/v1/apigee-gen.go +++ b/apigee/v1/apigee-gen.go @@ -32874,7 +32874,7 @@ func (c *OrganizationsEnvironmentsApisRevisionsDeployCall) Override(override boo // deployment will be capturing traffic from another environment under a // shared environment group or if traffic will be rerouted to a // different environment due to a base path removal. The -// GenerateDeployChangeReport API (GenerateDeployChangeReport) may be +// generateDeployChangeReport API (generateDeployChangeReport) may be // used to examine routing changes before issuing the deployment // request, and its response will indicate if a sequenced rollout is // recommended for the deployment. @@ -33000,7 +33000,7 @@ func (c *OrganizationsEnvironmentsApisRevisionsDeployCall) Do(opts ...googleapi. // "type": "boolean" // }, // "sequencedRollout": { - // "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", + // "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [generateDeployChangeReport API](generateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", // "location": "query", // "type": "boolean" // }, diff --git a/assuredworkloads/v1/assuredworkloads-api.json b/assuredworkloads/v1/assuredworkloads-api.json index 848578c08b7..449505cd18d 100644 --- a/assuredworkloads/v1/assuredworkloads-api.json +++ b/assuredworkloads/v1/assuredworkloads-api.json @@ -519,7 +519,7 @@ } } }, - "revision": "20230414", + "revision": "20230420", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -689,7 +689,7 @@ "type": "object" }, "GoogleCloudAssuredworkloadsV1Violation": { - "description": "Workload monitoring Violation. Next Id: 22", + "description": "Workload monitoring Violation. Next Id: 27", "id": "GoogleCloudAssuredworkloadsV1Violation", "properties": { "acknowledged": { @@ -727,14 +727,6 @@ "readOnly": true, "type": "string" }, - "exceptionContexts": { - "description": "Output only. List of all the exception detail added for the violation.", - "items": { - "$ref": "GoogleCloudAssuredworkloadsV1ViolationExceptionContext" - }, - "readOnly": true, - "type": "array" - }, "name": { "description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}", "readOnly": true, @@ -787,26 +779,6 @@ }, "type": "object" }, - "GoogleCloudAssuredworkloadsV1ViolationExceptionContext": { - "description": "Violation exception detail. Next Id: 5", - "id": "GoogleCloudAssuredworkloadsV1ViolationExceptionContext", - "properties": { - "acknowledgementTime": { - "description": "Timestamp when the violation was acknowledged.", - "format": "google-datetime", - "type": "string" - }, - "comment": { - "description": "Business justification provided towards the acknowledgement of the violation.", - "type": "string" - }, - "principalEmail": { - "description": "Email address of the user (or service account) who acknowledged the violation.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudAssuredworkloadsV1ViolationRemediation": { "description": "Represents remediation guidance to resolve compliance violation for AssuredWorkload", "id": "GoogleCloudAssuredworkloadsV1ViolationRemediation", diff --git a/assuredworkloads/v1/assuredworkloads-gen.go b/assuredworkloads/v1/assuredworkloads-gen.go index 8e6b76919b3..4fe158b1563 100644 --- a/assuredworkloads/v1/assuredworkloads-gen.go +++ b/assuredworkloads/v1/assuredworkloads-gen.go @@ -471,7 +471,7 @@ type GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse struct { } // GoogleCloudAssuredworkloadsV1Violation: Workload monitoring -// Violation. Next Id: 22 +// Violation. Next Id: 27 type GoogleCloudAssuredworkloadsV1Violation struct { // Acknowledged: A boolean that indicates if the violation is // acknowledged @@ -506,10 +506,6 @@ type GoogleCloudAssuredworkloadsV1Violation struct { // https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} ExceptionAuditLogLink string `json:"exceptionAuditLogLink,omitempty"` - // ExceptionContexts: Output only. List of all the exception detail - // added for the violation. - ExceptionContexts []*GoogleCloudAssuredworkloadsV1ViolationExceptionContext `json:"exceptionContexts,omitempty"` - // Name: Output only. Immutable. Name of the Violation. Format: // organizations/{organization}/locations/{location}/workloads/{workload_ // id}/violations/{violations_id} @@ -575,44 +571,6 @@ func (s *GoogleCloudAssuredworkloadsV1Violation) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAssuredworkloadsV1ViolationExceptionContext: Violation -// exception detail. Next Id: 5 -type GoogleCloudAssuredworkloadsV1ViolationExceptionContext struct { - // AcknowledgementTime: Timestamp when the violation was acknowledged. - AcknowledgementTime string `json:"acknowledgementTime,omitempty"` - - // Comment: Business justification provided towards the acknowledgement - // of the violation. - Comment string `json:"comment,omitempty"` - - // PrincipalEmail: Email address of the user (or service account) who - // acknowledged the violation. - PrincipalEmail string `json:"principalEmail,omitempty"` - - // ForceSendFields is a list of field names (e.g. "AcknowledgementTime") - // to unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "AcknowledgementTime") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *GoogleCloudAssuredworkloadsV1ViolationExceptionContext) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudAssuredworkloadsV1ViolationExceptionContext - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // GoogleCloudAssuredworkloadsV1ViolationRemediation: Represents // remediation guidance to resolve compliance violation for // AssuredWorkload diff --git a/assuredworkloads/v1beta1/assuredworkloads-api.json b/assuredworkloads/v1beta1/assuredworkloads-api.json index fac6689032d..943524a9659 100644 --- a/assuredworkloads/v1beta1/assuredworkloads-api.json +++ b/assuredworkloads/v1beta1/assuredworkloads-api.json @@ -595,7 +595,7 @@ } } }, - "revision": "20230414", + "revision": "20230420", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -699,7 +699,7 @@ "type": "object" }, "GoogleCloudAssuredworkloadsV1beta1Violation": { - "description": "Workload monitoring Violation. Next Id: 22", + "description": "Workload monitoring Violation. Next Id: 27", "id": "GoogleCloudAssuredworkloadsV1beta1Violation", "properties": { "acknowledged": { @@ -737,14 +737,6 @@ "readOnly": true, "type": "string" }, - "exceptionContexts": { - "description": "Output only. List of all the exception detail added for the violation.", - "items": { - "$ref": "GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext" - }, - "readOnly": true, - "type": "array" - }, "name": { "description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}", "readOnly": true, @@ -797,26 +789,6 @@ }, "type": "object" }, - "GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext": { - "description": "Violation exception detail. Next Id: 5", - "id": "GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext", - "properties": { - "acknowledgementTime": { - "description": "Timestamp when the violation was acknowledged.", - "format": "google-datetime", - "type": "string" - }, - "comment": { - "description": "Business justification provided towards the acknowledgement of the violation.", - "type": "string" - }, - "principalEmail": { - "description": "Email address of the user (or service account) who acknowledged the violation.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudAssuredworkloadsV1beta1ViolationRemediation": { "description": "Represents remediation guidance to resolve compliance violation for AssuredWorkload", "id": "GoogleCloudAssuredworkloadsV1beta1ViolationRemediation", @@ -990,6 +962,11 @@ "readOnly": true, "type": "array" }, + "controls": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls", + "description": "Output only. Controls associated with the customer workload", + "readOnly": true + }, "createTime": { "description": "Output only. Immutable. The Workload creation timestamp.", "format": "google-datetime", @@ -1114,6 +1091,39 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls": { + "description": "Controls enabled to the user associated with this workload", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls", + "properties": { + "appliedOrgPolicies": { + "description": "Output only. Org policies currently applied by this Assured Workload", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl": { + "description": "An org policy control applied by Assured Workloads", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl", + "properties": { + "constraint": { + "description": "Output only. Constraint name of the org policy control Example: constraints/gcp.resourcelocations", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Output only. Org policy version", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus": { "description": "Represents the Compliance Status of this workload", "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus", diff --git a/assuredworkloads/v1beta1/assuredworkloads-gen.go b/assuredworkloads/v1beta1/assuredworkloads-gen.go index 9d2e4c1d0e5..5accdad4f9c 100644 --- a/assuredworkloads/v1beta1/assuredworkloads-gen.go +++ b/assuredworkloads/v1beta1/assuredworkloads-gen.go @@ -490,7 +490,7 @@ type GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse struct { } // GoogleCloudAssuredworkloadsV1beta1Violation: Workload monitoring -// Violation. Next Id: 22 +// Violation. Next Id: 27 type GoogleCloudAssuredworkloadsV1beta1Violation struct { // Acknowledged: A boolean that indicates if the violation is // acknowledged @@ -525,10 +525,6 @@ type GoogleCloudAssuredworkloadsV1beta1Violation struct { // https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} ExceptionAuditLogLink string `json:"exceptionAuditLogLink,omitempty"` - // ExceptionContexts: Output only. List of all the exception detail - // added for the violation. - ExceptionContexts []*GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext `json:"exceptionContexts,omitempty"` - // Name: Output only. Immutable. Name of the Violation. Format: // organizations/{organization}/locations/{location}/workloads/{workload_ // id}/violations/{violations_id} @@ -594,44 +590,6 @@ func (s *GoogleCloudAssuredworkloadsV1beta1Violation) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext: -// Violation exception detail. Next Id: 5 -type GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext struct { - // AcknowledgementTime: Timestamp when the violation was acknowledged. - AcknowledgementTime string `json:"acknowledgementTime,omitempty"` - - // Comment: Business justification provided towards the acknowledgement - // of the violation. - Comment string `json:"comment,omitempty"` - - // PrincipalEmail: Email address of the user (or service account) who - // acknowledged the violation. - PrincipalEmail string `json:"principalEmail,omitempty"` - - // ForceSendFields is a list of field names (e.g. "AcknowledgementTime") - // to unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "AcknowledgementTime") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudAssuredworkloadsV1beta1ViolationExceptionContext - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // GoogleCloudAssuredworkloadsV1beta1ViolationRemediation: Represents // remediation guidance to resolve compliance violation for // AssuredWorkload @@ -850,6 +808,9 @@ type GoogleCloudAssuredworkloadsV1beta1Workload struct { // use these services in their environment." CompliantButDisallowedServices []string `json:"compliantButDisallowedServices,omitempty"` + // Controls: Output only. Controls associated with the customer workload + Controls *GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls `json:"controls,omitempty"` + // CreateTime: Output only. Immutable. The Workload creation timestamp. CreateTime string `json:"createTime,omitempty"` @@ -1014,6 +975,70 @@ func (s *GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings) MarshalJSON() ( return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls: +// Controls enabled to the user associated with this workload +type GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls struct { + // AppliedOrgPolicies: Output only. Org policies currently applied by + // this Assured Workload + AppliedOrgPolicies []*GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl `json:"appliedOrgPolicies,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AppliedOrgPolicies") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AppliedOrgPolicies") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControls + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyC +// ontrol: An org policy control applied by Assured Workloads +type GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl struct { + // Constraint: Output only. Constraint name of the org policy control + // Example: constraints/gcp.resourcelocations + Constraint string `json:"constraint,omitempty"` + + // Version: Output only. Org policy version + Version int64 `json:"version,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Constraint") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Constraint") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceControlsOrgPolicyControl + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus: // Represents the Compliance Status of this workload type GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus struct { diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index 8497f90b693..89ea972ba35 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -518,7 +518,7 @@ } } }, - "revision": "20230418", + "revision": "20230423", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -2264,7 +2264,7 @@ }, "member": { "$ref": "User", - "description": "The Google Chat user or app the membership corresponds to." + "description": "The Google Chat user or app the membership corresponds to. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`." }, "name": { "description": "Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member}", diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index 37675fc9880..f8bbb4497b2 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -3283,7 +3283,12 @@ type Membership struct { // when a member joined or was invited to join a space. CreateTime string `json:"createTime,omitempty"` - // Member: The Google Chat user or app the membership corresponds to. + // Member: The Google Chat user or app the membership corresponds to. If + // your Chat app authenticates as a user + // (https://developers.google.com/chat/api/guides/auth/users), the + // output populates the user + // (https://developers.google.com/chat/api/reference/rest/v1/User) + // `name` and `type`. Member *User `json:"member,omitempty"` // Name: Resource name of the membership, assigned by the server. diff --git a/datacatalog/v1/datacatalog-api.json b/datacatalog/v1/datacatalog-api.json index 7ed1c4729ca..cd736a2e78e 100644 --- a/datacatalog/v1/datacatalog-api.json +++ b/datacatalog/v1/datacatalog-api.json @@ -2134,7 +2134,7 @@ } } }, - "revision": "20230414", + "revision": "20230421", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -4240,7 +4240,7 @@ "id": "GoogleCloudDatacatalogV1TaxonomyService", "properties": { "identity": { - "description": "P4SA Identity of the service.", + "description": "The service agent for the service.", "type": "string" }, "name": { diff --git a/datacatalog/v1/datacatalog-gen.go b/datacatalog/v1/datacatalog-gen.go index 1cd31d650b5..cb4a84176be 100644 --- a/datacatalog/v1/datacatalog-gen.go +++ b/datacatalog/v1/datacatalog-gen.go @@ -4064,7 +4064,7 @@ func (s *GoogleCloudDatacatalogV1Taxonomy) MarshalJSON() ([]byte, error) { // GoogleCloudDatacatalogV1TaxonomyService: The source system of the // Taxonomy. type GoogleCloudDatacatalogV1TaxonomyService struct { - // Identity: P4SA Identity of the service. + // Identity: The service agent for the service. Identity string `json:"identity,omitempty"` // Name: The Google Cloud service name. diff --git a/datacatalog/v1beta1/datacatalog-api.json b/datacatalog/v1beta1/datacatalog-api.json index a42db2bb2e1..61bbd5e8ea6 100644 --- a/datacatalog/v1beta1/datacatalog-api.json +++ b/datacatalog/v1beta1/datacatalog-api.json @@ -1813,7 +1813,7 @@ } } }, - "revision": "20230414", + "revision": "20230421", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -4190,7 +4190,7 @@ "id": "GoogleCloudDatacatalogV1beta1TaxonomyService", "properties": { "identity": { - "description": "P4SA Identity of the service.", + "description": "The service agent for the service.", "type": "string" }, "name": { diff --git a/datacatalog/v1beta1/datacatalog-gen.go b/datacatalog/v1beta1/datacatalog-gen.go index 74d6cf0ae75..80ae7493d4e 100644 --- a/datacatalog/v1beta1/datacatalog-gen.go +++ b/datacatalog/v1beta1/datacatalog-gen.go @@ -4529,7 +4529,7 @@ func (s *GoogleCloudDatacatalogV1beta1Taxonomy) MarshalJSON() ([]byte, error) { // GoogleCloudDatacatalogV1beta1TaxonomyService: The source system of // the Taxonomy. type GoogleCloudDatacatalogV1beta1TaxonomyService struct { - // Identity: P4SA Identity of the service. + // Identity: The service agent for the service. Identity string `json:"identity,omitempty"` // Name: The Google Cloud service name. diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 1c9bb182086..aeb55a7def5 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -127,7 +127,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -160,7 +160,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -185,7 +185,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -238,18 +238,18 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -527,7 +527,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -650,6 +650,39 @@ } } }, + "engines": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -738,7 +771,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -771,7 +804,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -796,7 +829,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -849,18 +882,18 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -1138,7 +1171,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -1406,7 +1439,7 @@ } } }, - "revision": "20230412", + "revision": "20230424", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1607,7 +1640,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", "properties": { "numbers": { - "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "format": "double", "type": "number" @@ -1615,7 +1648,7 @@ "type": "array" }, "text": { - "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "type": "string" }, @@ -1633,7 +1666,7 @@ "type": "string" }, "jsonData": { - "description": "The JSON string representation of the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown.", + "description": "The JSON string representation of the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" }, "name": { @@ -1653,7 +1686,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The structured JSON data for the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown.", + "description": "The structured JSON data for the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", "type": "object" } }, @@ -1668,7 +1701,7 @@ "type": "string" }, "name": { - "description": "Required. The Document resource full name, of the form: projects/{project\\_id}/locations/{location}/collections/{collection\\_id}/dataStores/{data\\_store\\_id}/branches/{branch\\_id}/documents/{document\\_id}", + "description": "Required. The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, "promotionIds": { @@ -1931,7 +1964,7 @@ "type": "string" }, "mediaProgressPercentage": { - "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between [0, 1.0] inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", + "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", "format": "float", "type": "number" } @@ -1991,7 +2024,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * (filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\")) * (filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with storageStatus of \"EXPIRED\" or \"DELETED\" regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { @@ -2003,7 +2036,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * 'no-diversity' * 'low-diversity' * 'medium-diversity' * 'high-diversity' * 'auto-diversity' This gives request-level control and adjusts recommendation results based on Document category.", + "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.", "type": "object" }, "userEvent": { @@ -2161,7 +2194,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomAttribute" }, - "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", + "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is ` traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { @@ -2250,11 +2283,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", "type": "string" }, "userId": { - "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index 9a174bed80e..8aaa186bb2d 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -174,6 +174,7 @@ type ProjectsLocationsService struct { func NewProjectsLocationsCollectionsService(s *Service) *ProjectsLocationsCollectionsService { rs := &ProjectsLocationsCollectionsService{s: s} rs.DataStores = NewProjectsLocationsCollectionsDataStoresService(s) + rs.Engines = NewProjectsLocationsCollectionsEnginesService(s) rs.Operations = NewProjectsLocationsCollectionsOperationsService(s) return rs } @@ -183,6 +184,8 @@ type ProjectsLocationsCollectionsService struct { DataStores *ProjectsLocationsCollectionsDataStoresService + Engines *ProjectsLocationsCollectionsEnginesService + Operations *ProjectsLocationsCollectionsOperationsService } @@ -291,6 +294,27 @@ type ProjectsLocationsCollectionsDataStoresUserEventsService struct { s *Service } +func NewProjectsLocationsCollectionsEnginesService(s *Service) *ProjectsLocationsCollectionsEnginesService { + rs := &ProjectsLocationsCollectionsEnginesService{s: s} + rs.Operations = NewProjectsLocationsCollectionsEnginesOperationsService(s) + return rs +} + +type ProjectsLocationsCollectionsEnginesService struct { + s *Service + + Operations *ProjectsLocationsCollectionsEnginesOperationsService +} + +func NewProjectsLocationsCollectionsEnginesOperationsService(s *Service) *ProjectsLocationsCollectionsEnginesOperationsService { + rs := &ProjectsLocationsCollectionsEnginesOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsEnginesOperationsService struct { + s *Service +} + func NewProjectsLocationsCollectionsOperationsService(s *Service) *ProjectsLocationsCollectionsOperationsService { rs := &ProjectsLocationsCollectionsOperationsService{s: s} return rs @@ -821,16 +845,16 @@ func (s *GoogleCloudDiscoveryengineV1alphaCompletionInfo) MarshalJSON() ([]byte, // that is not explicitly modeled in a resource, e.g. UserEvent. type GoogleCloudDiscoveryengineV1alphaCustomAttribute struct { // Numbers: The numerical values of this custom attribute. For example, - // `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or - // numbers should be set. Otherwise, an INVALID_ARGUMENT error is - // returned. + // `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of + // CustomAttribute.text or CustomAttribute.numbers should be set. + // Otherwise, an `INVALID_ARGUMENT` error is returned. Numbers []float64 `json:"numbers,omitempty"` // Text: The textual values of this custom attribute. For example, // `["yellow", "green"]` when the key is "color". Empty string is not - // allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly - // one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT - // error is returned. + // allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly + // one of CustomAttribute.text or CustomAttribute.numbers should be set. + // Otherwise, an `INVALID_ARGUMENT` error is returned. Text []string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Numbers") to @@ -865,8 +889,8 @@ type GoogleCloudDiscoveryengineV1alphaDocument struct { Id string `json:"id,omitempty"` // JsonData: The JSON string representation of the document. It should - // conform to the registered schema or an INVALID_ARGUMENT error is - // thrown. + // conform to the registered Schema.schema or an `INVALID_ARGUMENT` + // error is thrown. JsonData string `json:"jsonData,omitempty"` // Name: Immutable. The full resource name of the document. Format: @@ -887,8 +911,8 @@ type GoogleCloudDiscoveryengineV1alphaDocument struct { SchemaId string `json:"schemaId,omitempty"` // StructData: The structured JSON data for the document. It should - // conform to the registered schema or an INVALID_ARGUMENT error is - // thrown. + // conform to the registered Schema.schema or an `INVALID_ARGUMENT` + // error is thrown. StructData googleapi.RawMessage `json:"structData,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -925,9 +949,9 @@ type GoogleCloudDiscoveryengineV1alphaDocumentInfo struct { Id string `json:"id,omitempty"` // Name: Required. The Document resource full name, of the form: - // projects/{project\_id}/locations/{location}/collections/{collection\_i - // d}/dataStores/{data\_store\_id}/branches/{branch\_id}/documents/{docum - // ent\_id} + // `projects/{project_id}/locations/{location}/collections/{collection_id + // }/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_ + // id}` Name string `json:"name,omitempty"` // PromotionIds: The promotion IDs associated with this Document. @@ -1409,7 +1433,7 @@ type GoogleCloudDiscoveryengineV1alphaMediaInfo struct { // MediaProgressPercentage: Media progress should be computed using only // the media_progress_duration relative to the media total length. This - // value must be between [0, 1.0] inclusive. If this is not a playback + // value must be between `[0, 1.0]` inclusive. If this is not a playback // or the progress cannot be computed (e.g. ongoing livestream), this // field should be unset. MediaProgressPercentage float64 `json:"mediaProgressPercentage,omitempty"` @@ -1556,15 +1580,15 @@ func (s *GoogleCloudDiscoveryengineV1alphaPanelInfo) MarshalJSON() ([]byte, erro type GoogleCloudDiscoveryengineV1alphaRecommendRequest struct { // Filter: Filter for restricting recommendation results with a length // limit of 5,000 characters. Currently, only filter expressions on the - // `filter_tags` attribute is supported. Examples: * (filter_tags: - // ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold")) * - // (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green")) - // If your filter blocks all results, the API will return generic - // (unfiltered) popular Documents. If you only want results strictly - // matching the filters, set `strictFiltering` to True in + // `filter_tags` attribute is supported. Examples: * `(filter_tags: + // ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * + // `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: + // ANY("Green"))` If your filter blocks all results, the API will return + // generic (unfiltered) popular Documents. If you only want results + // strictly matching the filters, set `strictFiltering` to True in // RecommendRequest.params to receive empty results instead. Note that - // the API will never return Documents with storageStatus of "EXPIRED" - // or "DELETED" regardless of filter choices. + // the API will never return Documents with `storageStatus` of `EXPIRED` + // or `DELETED` regardless of filter choices. Filter string `json:"filter,omitempty"` // PageSize: Maximum number of results to return. Set this property to @@ -1576,18 +1600,19 @@ type GoogleCloudDiscoveryengineV1alphaRecommendRequest struct { // Params: Additional domain specific parameters for the // recommendations. Allowed values: * `returnDocument`: Boolean. If set // to true, the associated Document object will be returned in - // RecommendResponse.results.document. * `returnScore`: Boolean. If set - // to true, the recommendation 'score' corresponding to each returned - // Document will be set in RecommendResponse.results.metadata. The given - // 'score' indicates the probability of a Document conversion given the - // user's context and history. * `strictFiltering`: Boolean. True by - // default. If set to false, the service will return generic - // (unfiltered) popular Documents instead of empty if your filter blocks - // all recommendation results. * `diversityLevel`: String. Default - // empty. If set to be non-empty, then it needs to be one of: * - // 'no-diversity' * 'low-diversity' * 'medium-diversity' * - // 'high-diversity' * 'auto-diversity' This gives request-level control - // and adjusts recommendation results based on Document category. + // RecommendResponse.RecommendationResult.document. * `returnScore`: + // Boolean. If set to true, the recommendation 'score' corresponding to + // each returned Document will be set in + // RecommendResponse.RecommendationResult.metadata. The given 'score' + // indicates the probability of a Document conversion given the user's + // context and history. * `strictFiltering`: Boolean. True by default. + // If set to false, the service will return generic (unfiltered) popular + // Documents instead of empty if your filter blocks all recommendation + // results. * `diversityLevel`: String. Default empty. If set to be + // non-empty, then it needs to be one of: * `no-diversity` * + // `low-diversity` * `medium-diversity` * `high-diversity` * + // `auto-diversity` This gives request-level control and adjusts + // recommendation results based on Document category. Params googleapi.RawMessage `json:"params,omitempty"` // UserEvent: Required. Context about the user, what they are looking at @@ -1913,13 +1938,13 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // This lets the Discovery Engine API use those custom attributes when // training models and serving predictions, which helps improve // recommendation quality. This field needs to pass all below criteria, - // otherwise an INVALID_ARGUMENT error is returned: * The key must be a - // UTF-8 encoded string with a length limit of 5,000 characters. * For + // otherwise an `INVALID_ARGUMENT` error is returned: * The key must be + // a UTF-8 encoded string with a length limit of 5,000 characters. * For // text attributes, at most 400 values are allowed. Empty values are not // allowed. Each value must be a UTF-8 encoded string with a length // limit of 256 characters. * For number attributes, at most 400 values // are allowed. For product recommendations, an example of extra user - // information is traffic_channel, which is how a user arrives at the + // information is ` traffic_channel`, which is how a user arrives at the // site. Users can arrive at the site by coming to the site directly, // coming through Google search, or in other ways. Attributes map[string]GoogleCloudDiscoveryengineV1alphaCustomAttribute `json:"attributes,omitempty"` @@ -2081,8 +2106,8 @@ type GoogleCloudDiscoveryengineV1alphaUserInfo struct { // UserAgent: User agent as included in the HTTP header. Required for // getting SearchResponse.sponsored_results. The field must be a UTF-8 // encoded string with a length limit of 1,000 characters. Otherwise, an - // INVALID_ARGUMENT error is returned. This should not be set when using - // the client side event reporting with GTM or JavaScript tag in + // `INVALID_ARGUMENT` error is returned. This should not be set when + // using the client side event reporting with GTM or JavaScript tag in // UserEventService.CollectUserEvent or if direct_user_request is set. UserAgent string `json:"userAgent,omitempty"` @@ -2092,7 +2117,7 @@ type GoogleCloudDiscoveryengineV1alphaUserInfo struct { // same fixed ID for different users. This mixes the event history of // those users together, which results in degraded model quality. The // field must be a UTF-8 encoded string with a length limit of 128 - // characters. Otherwise, an INVALID_ARGUMENT error is returned. + // characters. Otherwise, an `INVALID_ARGUMENT` error is returned. UserId string `json:"userId,omitempty"` // ForceSendFields is a list of field names (e.g. "UserAgent") to @@ -2580,12 +2605,13 @@ func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) Create( // DocumentId sets the optional parameter "documentId": Required. The ID // to use for the Document, which will become the final component of the // Document.name. If the caller does not have permission to create the -// Document, regardless of whether or not it exists, a PERMISSION_DENIED -// error is returned. This field must be unique among all Documents with -// the same parent. Otherwise, an ALREADY_EXISTS error is returned. This -// field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034) -// standard with a length limit of 63 characters. Otherwise, an -// INVALID_ARGUMENT error is returned. +// Document, regardless of whether or not it exists, a +// `PERMISSION_DENIED` error is returned. This field must be unique +// among all Documents with the same parent. Otherwise, an +// `ALREADY_EXISTS` error is returned. This field must conform to +// RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length +// limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is +// returned. func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall) DocumentId(documentId string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall { c.urlParams_.Set("documentId", documentId) return c @@ -2693,7 +2719,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall) Do(o // ], // "parameters": { // "documentId": { - // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, @@ -2735,9 +2761,9 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to delete the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the Document to delete does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the Document to delete does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) Delete(name string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall { c := &ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -2839,7 +2865,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall) Do(o // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -2874,9 +2900,9 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to access the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the requested Document does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the requested Document does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) Get(name string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall { c := &ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -2993,7 +3019,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall) Do(opts // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -3177,7 +3203,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall struct { // the branch ID, to list documents under the default branch. If the // caller does not have permission to list Documentss under this // branch, regardless of whether or not this branch exists, a -// PERMISSION_DENIED error is returned. +// `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { c := &ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -3187,7 +3213,7 @@ func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) List(pa // PageSize sets the optional parameter "pageSize": Maximum number of // Documents to return. If unspecified, defaults to 100. The maximum // allowed value is 1000. Values above 1000 will be coerced to 1000. If -// this field is negative, an INVALID_ARGUMENT error is returned. +// this field is negative, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -3198,7 +3224,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) PageSi // DocumentService.ListDocuments call. Provide this to retrieve the // subsequent page. When paginating, all other parameters provided to // DocumentService.ListDocuments must match the call that provided the -// page token. Otherwise, an INVALID_ARGUMENT error is returned. +// page token. Otherwise, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -3315,18 +3341,18 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) Do(opt // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -4605,8 +4631,8 @@ type ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall struct { // event. // // - servingConfig: Full resource name of the format: -// projects/*/locations/global/collections/*/dataStores/*/servingConfig -// s/* Before you can request recommendations from your model, you +// `projects/*/locations/global/collections/*/dataStores/*/servingConfi +// gs/*` Before you can request recommendations from your model, you // must create at least one serving config for it. func (r *ProjectsLocationsCollectionsDataStoresServingConfigsService) Recommend(servingConfig string, googleclouddiscoveryenginev1alpharecommendrequest *GoogleCloudDiscoveryengineV1alphaRecommendRequest) *ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall { c := &ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -4717,7 +4743,7 @@ func (c *ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall) Do(o // ], // "parameters": { // "servingConfig": { - // "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + // "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", // "required": true, @@ -5225,6 +5251,154 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsWriteCall) Do(opts ...g } +// method id "discoveryengine.projects.locations.collections.engines.operations.get": + +type ProjectsLocationsCollectionsEnginesOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets the latest state of a long-running operation. Clients can +// use this method to poll the operation result at intervals as +// recommended by the API service. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsEnginesOperationsService) Get(name string) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c := &ProjectsLocationsCollectionsEnginesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.operations.get" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "discoveryengine.projects.locations.collections.engines.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+name}", + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "discoveryengine.projects.locations.collections.operations.get": type ProjectsLocationsCollectionsOperationsGetCall struct { @@ -5606,12 +5780,13 @@ func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Create(parent stri // DocumentId sets the optional parameter "documentId": Required. The ID // to use for the Document, which will become the final component of the // Document.name. If the caller does not have permission to create the -// Document, regardless of whether or not it exists, a PERMISSION_DENIED -// error is returned. This field must be unique among all Documents with -// the same parent. Otherwise, an ALREADY_EXISTS error is returned. This -// field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034) -// standard with a length limit of 63 characters. Otherwise, an -// INVALID_ARGUMENT error is returned. +// Document, regardless of whether or not it exists, a +// `PERMISSION_DENIED` error is returned. This field must be unique +// among all Documents with the same parent. Otherwise, an +// `ALREADY_EXISTS` error is returned. This field must conform to +// RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length +// limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is +// returned. func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) DocumentId(documentId string) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall { c.urlParams_.Set("documentId", documentId) return c @@ -5719,7 +5894,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Do(opts ...goog // ], // "parameters": { // "documentId": { - // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, @@ -5761,9 +5936,9 @@ type ProjectsLocationsDataStoresBranchesDocumentsDeleteCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to delete the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the Document to delete does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the Document to delete does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Delete(name string) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall { c := &ProjectsLocationsDataStoresBranchesDocumentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -5865,7 +6040,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Do(opts ...goog // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -5900,9 +6075,9 @@ type ProjectsLocationsDataStoresBranchesDocumentsGetCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to access the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the requested Document does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the requested Document does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Get(name string) *ProjectsLocationsDataStoresBranchesDocumentsGetCall { c := &ProjectsLocationsDataStoresBranchesDocumentsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -6019,7 +6194,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Do(opts ...googlea // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -6203,7 +6378,7 @@ type ProjectsLocationsDataStoresBranchesDocumentsListCall struct { // the branch ID, to list documents under the default branch. If the // caller does not have permission to list Documentss under this // branch, regardless of whether or not this branch exists, a -// PERMISSION_DENIED error is returned. +// `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsDataStoresBranchesDocumentsListCall { c := &ProjectsLocationsDataStoresBranchesDocumentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -6213,7 +6388,7 @@ func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string // PageSize sets the optional parameter "pageSize": Maximum number of // Documents to return. If unspecified, defaults to 100. The maximum // allowed value is 1000. Values above 1000 will be coerced to 1000. If -// this field is negative, an INVALID_ARGUMENT error is returned. +// this field is negative, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -6224,7 +6399,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize(pageSize // DocumentService.ListDocuments call. Provide this to retrieve the // subsequent page. When paginating, all other parameters provided to // DocumentService.ListDocuments must match the call that provided the -// page token. Otherwise, an INVALID_ARGUMENT error is returned. +// page token. Otherwise, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -6341,18 +6516,18 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Do(opts ...google // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -7631,8 +7806,8 @@ type ProjectsLocationsDataStoresServingConfigsRecommendCall struct { // event. // // - servingConfig: Full resource name of the format: -// projects/*/locations/global/collections/*/dataStores/*/servingConfig -// s/* Before you can request recommendations from your model, you +// `projects/*/locations/global/collections/*/dataStores/*/servingConfi +// gs/*` Before you can request recommendations from your model, you // must create at least one serving config for it. func (r *ProjectsLocationsDataStoresServingConfigsService) Recommend(servingConfig string, googleclouddiscoveryenginev1alpharecommendrequest *GoogleCloudDiscoveryengineV1alphaRecommendRequest) *ProjectsLocationsDataStoresServingConfigsRecommendCall { c := &ProjectsLocationsDataStoresServingConfigsRecommendCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7743,7 +7918,7 @@ func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Do(opts ...goog // ], // "parameters": { // "servingConfig": { - // "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + // "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", // "required": true, diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index 0f5f4bf36db..b8504a7f4a3 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -127,7 +127,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -160,7 +160,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -185,7 +185,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -238,18 +238,18 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -527,7 +527,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -650,6 +650,39 @@ } } }, + "engines": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -738,7 +771,7 @@ ], "parameters": { "documentId": { - "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, @@ -771,7 +804,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -796,7 +829,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, @@ -849,18 +882,18 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -1138,7 +1171,7 @@ ], "parameters": { "servingConfig": { - "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -1406,7 +1439,7 @@ } } }, - "revision": "20230412", + "revision": "20230424", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1741,7 +1774,7 @@ "id": "GoogleCloudDiscoveryengineV1betaCustomAttribute", "properties": { "numbers": { - "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "format": "double", "type": "number" @@ -1749,7 +1782,7 @@ "type": "array" }, "text": { - "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "type": "string" }, @@ -1767,7 +1800,7 @@ "type": "string" }, "jsonData": { - "description": "The JSON string representation of the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown.", + "description": "The JSON string representation of the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" }, "name": { @@ -1787,7 +1820,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The structured JSON data for the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown.", + "description": "The structured JSON data for the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", "type": "object" } }, @@ -1802,7 +1835,7 @@ "type": "string" }, "name": { - "description": "Required. The Document resource full name, of the form: projects/{project\\_id}/locations/{location}/collections/{collection\\_id}/dataStores/{data\\_store\\_id}/branches/{branch\\_id}/documents/{document\\_id}", + "description": "Required. The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, "promotionIds": { @@ -2065,7 +2098,7 @@ "type": "string" }, "mediaProgressPercentage": { - "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between [0, 1.0] inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", + "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", "format": "float", "type": "number" } @@ -2125,7 +2158,7 @@ "id": "GoogleCloudDiscoveryengineV1betaRecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * (filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\")) * (filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with storageStatus of \"EXPIRED\" or \"DELETED\" regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { @@ -2137,7 +2170,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * 'no-diversity' * 'low-diversity' * 'medium-diversity' * 'high-diversity' * 'auto-diversity' This gives request-level control and adjusts recommendation results based on Document category.", + "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.", "type": "object" }, "userEvent": { @@ -2295,7 +2328,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaCustomAttribute" }, - "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", + "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is ` traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { @@ -2384,11 +2417,11 @@ "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "properties": { "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", "type": "string" }, "userId": { - "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index a5d5d8f1ac1..10ab36bfed4 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -174,6 +174,7 @@ type ProjectsLocationsService struct { func NewProjectsLocationsCollectionsService(s *Service) *ProjectsLocationsCollectionsService { rs := &ProjectsLocationsCollectionsService{s: s} rs.DataStores = NewProjectsLocationsCollectionsDataStoresService(s) + rs.Engines = NewProjectsLocationsCollectionsEnginesService(s) rs.Operations = NewProjectsLocationsCollectionsOperationsService(s) return rs } @@ -183,6 +184,8 @@ type ProjectsLocationsCollectionsService struct { DataStores *ProjectsLocationsCollectionsDataStoresService + Engines *ProjectsLocationsCollectionsEnginesService + Operations *ProjectsLocationsCollectionsOperationsService } @@ -291,6 +294,27 @@ type ProjectsLocationsCollectionsDataStoresUserEventsService struct { s *Service } +func NewProjectsLocationsCollectionsEnginesService(s *Service) *ProjectsLocationsCollectionsEnginesService { + rs := &ProjectsLocationsCollectionsEnginesService{s: s} + rs.Operations = NewProjectsLocationsCollectionsEnginesOperationsService(s) + return rs +} + +type ProjectsLocationsCollectionsEnginesService struct { + s *Service + + Operations *ProjectsLocationsCollectionsEnginesOperationsService +} + +func NewProjectsLocationsCollectionsEnginesOperationsService(s *Service) *ProjectsLocationsCollectionsEnginesOperationsService { + rs := &ProjectsLocationsCollectionsEnginesOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsEnginesOperationsService struct { + s *Service +} + func NewProjectsLocationsCollectionsOperationsService(s *Service) *ProjectsLocationsCollectionsOperationsService { rs := &ProjectsLocationsCollectionsOperationsService{s: s} return rs @@ -1056,16 +1080,16 @@ func (s *GoogleCloudDiscoveryengineV1betaCompletionInfo) MarshalJSON() ([]byte, // that is not explicitly modeled in a resource, e.g. UserEvent. type GoogleCloudDiscoveryengineV1betaCustomAttribute struct { // Numbers: The numerical values of this custom attribute. For example, - // `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or - // numbers should be set. Otherwise, an INVALID_ARGUMENT error is - // returned. + // `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of + // CustomAttribute.text or CustomAttribute.numbers should be set. + // Otherwise, an `INVALID_ARGUMENT` error is returned. Numbers []float64 `json:"numbers,omitempty"` // Text: The textual values of this custom attribute. For example, // `["yellow", "green"]` when the key is "color". Empty string is not - // allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly - // one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT - // error is returned. + // allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly + // one of CustomAttribute.text or CustomAttribute.numbers should be set. + // Otherwise, an `INVALID_ARGUMENT` error is returned. Text []string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Numbers") to @@ -1100,8 +1124,8 @@ type GoogleCloudDiscoveryengineV1betaDocument struct { Id string `json:"id,omitempty"` // JsonData: The JSON string representation of the document. It should - // conform to the registered schema or an INVALID_ARGUMENT error is - // thrown. + // conform to the registered Schema.schema or an `INVALID_ARGUMENT` + // error is thrown. JsonData string `json:"jsonData,omitempty"` // Name: Immutable. The full resource name of the document. Format: @@ -1122,8 +1146,8 @@ type GoogleCloudDiscoveryengineV1betaDocument struct { SchemaId string `json:"schemaId,omitempty"` // StructData: The structured JSON data for the document. It should - // conform to the registered schema or an INVALID_ARGUMENT error is - // thrown. + // conform to the registered Schema.schema or an `INVALID_ARGUMENT` + // error is thrown. StructData googleapi.RawMessage `json:"structData,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1160,9 +1184,9 @@ type GoogleCloudDiscoveryengineV1betaDocumentInfo struct { Id string `json:"id,omitempty"` // Name: Required. The Document resource full name, of the form: - // projects/{project\_id}/locations/{location}/collections/{collection\_i - // d}/dataStores/{data\_store\_id}/branches/{branch\_id}/documents/{docum - // ent\_id} + // `projects/{project_id}/locations/{location}/collections/{collection_id + // }/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_ + // id}` Name string `json:"name,omitempty"` // PromotionIds: The promotion IDs associated with this Document. @@ -1644,7 +1668,7 @@ type GoogleCloudDiscoveryengineV1betaMediaInfo struct { // MediaProgressPercentage: Media progress should be computed using only // the media_progress_duration relative to the media total length. This - // value must be between [0, 1.0] inclusive. If this is not a playback + // value must be between `[0, 1.0]` inclusive. If this is not a playback // or the progress cannot be computed (e.g. ongoing livestream), this // field should be unset. MediaProgressPercentage float64 `json:"mediaProgressPercentage,omitempty"` @@ -1791,15 +1815,15 @@ func (s *GoogleCloudDiscoveryengineV1betaPanelInfo) MarshalJSON() ([]byte, error type GoogleCloudDiscoveryengineV1betaRecommendRequest struct { // Filter: Filter for restricting recommendation results with a length // limit of 5,000 characters. Currently, only filter expressions on the - // `filter_tags` attribute is supported. Examples: * (filter_tags: - // ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold")) * - // (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green")) - // If your filter blocks all results, the API will return generic - // (unfiltered) popular Documents. If you only want results strictly - // matching the filters, set `strictFiltering` to True in + // `filter_tags` attribute is supported. Examples: * `(filter_tags: + // ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * + // `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: + // ANY("Green"))` If your filter blocks all results, the API will return + // generic (unfiltered) popular Documents. If you only want results + // strictly matching the filters, set `strictFiltering` to True in // RecommendRequest.params to receive empty results instead. Note that - // the API will never return Documents with storageStatus of "EXPIRED" - // or "DELETED" regardless of filter choices. + // the API will never return Documents with `storageStatus` of `EXPIRED` + // or `DELETED` regardless of filter choices. Filter string `json:"filter,omitempty"` // PageSize: Maximum number of results to return. Set this property to @@ -1811,18 +1835,19 @@ type GoogleCloudDiscoveryengineV1betaRecommendRequest struct { // Params: Additional domain specific parameters for the // recommendations. Allowed values: * `returnDocument`: Boolean. If set // to true, the associated Document object will be returned in - // RecommendResponse.results.document. * `returnScore`: Boolean. If set - // to true, the recommendation 'score' corresponding to each returned - // Document will be set in RecommendResponse.results.metadata. The given - // 'score' indicates the probability of a Document conversion given the - // user's context and history. * `strictFiltering`: Boolean. True by - // default. If set to false, the service will return generic - // (unfiltered) popular Documents instead of empty if your filter blocks - // all recommendation results. * `diversityLevel`: String. Default - // empty. If set to be non-empty, then it needs to be one of: * - // 'no-diversity' * 'low-diversity' * 'medium-diversity' * - // 'high-diversity' * 'auto-diversity' This gives request-level control - // and adjusts recommendation results based on Document category. + // RecommendResponse.RecommendationResult.document. * `returnScore`: + // Boolean. If set to true, the recommendation 'score' corresponding to + // each returned Document will be set in + // RecommendResponse.RecommendationResult.metadata. The given 'score' + // indicates the probability of a Document conversion given the user's + // context and history. * `strictFiltering`: Boolean. True by default. + // If set to false, the service will return generic (unfiltered) popular + // Documents instead of empty if your filter blocks all recommendation + // results. * `diversityLevel`: String. Default empty. If set to be + // non-empty, then it needs to be one of: * `no-diversity` * + // `low-diversity` * `medium-diversity` * `high-diversity` * + // `auto-diversity` This gives request-level control and adjusts + // recommendation results based on Document category. Params googleapi.RawMessage `json:"params,omitempty"` // UserEvent: Required. Context about the user, what they are looking at @@ -2150,13 +2175,13 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // This lets the Discovery Engine API use those custom attributes when // training models and serving predictions, which helps improve // recommendation quality. This field needs to pass all below criteria, - // otherwise an INVALID_ARGUMENT error is returned: * The key must be a - // UTF-8 encoded string with a length limit of 5,000 characters. * For + // otherwise an `INVALID_ARGUMENT` error is returned: * The key must be + // a UTF-8 encoded string with a length limit of 5,000 characters. * For // text attributes, at most 400 values are allowed. Empty values are not // allowed. Each value must be a UTF-8 encoded string with a length // limit of 256 characters. * For number attributes, at most 400 values // are allowed. For product recommendations, an example of extra user - // information is traffic_channel, which is how a user arrives at the + // information is ` traffic_channel`, which is how a user arrives at the // site. Users can arrive at the site by coming to the site directly, // coming through Google search, or in other ways. Attributes map[string]GoogleCloudDiscoveryengineV1betaCustomAttribute `json:"attributes,omitempty"` @@ -2317,8 +2342,8 @@ type GoogleCloudDiscoveryengineV1betaUserInfo struct { // UserAgent: User agent as included in the HTTP header. Required for // getting SearchResponse.sponsored_results. The field must be a UTF-8 // encoded string with a length limit of 1,000 characters. Otherwise, an - // INVALID_ARGUMENT error is returned. This should not be set when using - // the client side event reporting with GTM or JavaScript tag in + // `INVALID_ARGUMENT` error is returned. This should not be set when + // using the client side event reporting with GTM or JavaScript tag in // UserEventService.CollectUserEvent or if direct_user_request is set. UserAgent string `json:"userAgent,omitempty"` @@ -2328,7 +2353,7 @@ type GoogleCloudDiscoveryengineV1betaUserInfo struct { // same fixed ID for different users. This mixes the event history of // those users together, which results in degraded model quality. The // field must be a UTF-8 encoded string with a length limit of 128 - // characters. Otherwise, an INVALID_ARGUMENT error is returned. + // characters. Otherwise, an `INVALID_ARGUMENT` error is returned. UserId string `json:"userId,omitempty"` // ForceSendFields is a list of field names (e.g. "UserAgent") to @@ -2581,12 +2606,13 @@ func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) Create( // DocumentId sets the optional parameter "documentId": Required. The ID // to use for the Document, which will become the final component of the // Document.name. If the caller does not have permission to create the -// Document, regardless of whether or not it exists, a PERMISSION_DENIED -// error is returned. This field must be unique among all Documents with -// the same parent. Otherwise, an ALREADY_EXISTS error is returned. This -// field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034) -// standard with a length limit of 63 characters. Otherwise, an -// INVALID_ARGUMENT error is returned. +// Document, regardless of whether or not it exists, a +// `PERMISSION_DENIED` error is returned. This field must be unique +// among all Documents with the same parent. Otherwise, an +// `ALREADY_EXISTS` error is returned. This field must conform to +// RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length +// limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is +// returned. func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall) DocumentId(documentId string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall { c.urlParams_.Set("documentId", documentId) return c @@ -2694,7 +2720,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsCreateCall) Do(o // ], // "parameters": { // "documentId": { - // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, @@ -2736,9 +2762,9 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to delete the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the Document to delete does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the Document to delete does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) Delete(name string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall { c := &ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -2840,7 +2866,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsDeleteCall) Do(o // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -2875,9 +2901,9 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to access the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the requested Document does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the requested Document does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) Get(name string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall { c := &ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -2994,7 +3020,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsGetCall) Do(opts // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -3178,7 +3204,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall struct { // the branch ID, to list documents under the default branch. If the // caller does not have permission to list Documentss under this // branch, regardless of whether or not this branch exists, a -// PERMISSION_DENIED error is returned. +// `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { c := &ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -3188,7 +3214,7 @@ func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) List(pa // PageSize sets the optional parameter "pageSize": Maximum number of // Documents to return. If unspecified, defaults to 100. The maximum // allowed value is 1000. Values above 1000 will be coerced to 1000. If -// this field is negative, an INVALID_ARGUMENT error is returned. +// this field is negative, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -3199,7 +3225,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) PageSi // DocumentService.ListDocuments call. Provide this to retrieve the // subsequent page. When paginating, all other parameters provided to // DocumentService.ListDocuments must match the call that provided the -// page token. Otherwise, an INVALID_ARGUMENT error is returned. +// page token. Otherwise, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -3315,18 +3341,18 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) Do(opt // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -4605,8 +4631,8 @@ type ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall struct { // event. // // - servingConfig: Full resource name of the format: -// projects/*/locations/global/collections/*/dataStores/*/servingConfig -// s/* Before you can request recommendations from your model, you +// `projects/*/locations/global/collections/*/dataStores/*/servingConfi +// gs/*` Before you can request recommendations from your model, you // must create at least one serving config for it. func (r *ProjectsLocationsCollectionsDataStoresServingConfigsService) Recommend(servingConfig string, googleclouddiscoveryenginev1betarecommendrequest *GoogleCloudDiscoveryengineV1betaRecommendRequest) *ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall { c := &ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -4717,7 +4743,7 @@ func (c *ProjectsLocationsCollectionsDataStoresServingConfigsRecommendCall) Do(o // ], // "parameters": { // "servingConfig": { - // "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + // "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", // "required": true, @@ -5225,6 +5251,154 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsWriteCall) Do(opts ...g } +// method id "discoveryengine.projects.locations.collections.engines.operations.get": + +type ProjectsLocationsCollectionsEnginesOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets the latest state of a long-running operation. Clients can +// use this method to poll the operation result at intervals as +// recommended by the API service. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsEnginesOperationsService) Get(name string) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c := &ProjectsLocationsCollectionsEnginesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.operations.get" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "discoveryengine.projects.locations.collections.engines.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta/{+name}", + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "discoveryengine.projects.locations.collections.operations.get": type ProjectsLocationsCollectionsOperationsGetCall struct { @@ -5606,12 +5780,13 @@ func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Create(parent stri // DocumentId sets the optional parameter "documentId": Required. The ID // to use for the Document, which will become the final component of the // Document.name. If the caller does not have permission to create the -// Document, regardless of whether or not it exists, a PERMISSION_DENIED -// error is returned. This field must be unique among all Documents with -// the same parent. Otherwise, an ALREADY_EXISTS error is returned. This -// field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034) -// standard with a length limit of 63 characters. Otherwise, an -// INVALID_ARGUMENT error is returned. +// Document, regardless of whether or not it exists, a +// `PERMISSION_DENIED` error is returned. This field must be unique +// among all Documents with the same parent. Otherwise, an +// `ALREADY_EXISTS` error is returned. This field must conform to +// RFC-1034 (https://tools.ietf.org/html/rfc1034) standard with a length +// limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is +// returned. func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) DocumentId(documentId string) *ProjectsLocationsDataStoresBranchesDocumentsCreateCall { c.urlParams_.Set("documentId", documentId) return c @@ -5719,7 +5894,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsCreateCall) Do(opts ...goog // ], // "parameters": { // "documentId": { - // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, @@ -5761,9 +5936,9 @@ type ProjectsLocationsDataStoresBranchesDocumentsDeleteCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to delete the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the Document to delete does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the Document to delete does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Delete(name string) *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall { c := &ProjectsLocationsDataStoresBranchesDocumentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -5865,7 +6040,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsDeleteCall) Do(opts ...goog // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -5900,9 +6075,9 @@ type ProjectsLocationsDataStoresBranchesDocumentsGetCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}/documents/{document}`. If // the caller does not have permission to access the Document, -// regardless of whether or not it exists, a PERMISSION_DENIED error -// is returned. If the requested Document does not exist, a NOT_FOUND -// error is returned. +// regardless of whether or not it exists, a `PERMISSION_DENIED` error +// is returned. If the requested Document does not exist, a +// `NOT_FOUND` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) Get(name string) *ProjectsLocationsDataStoresBranchesDocumentsGetCall { c := &ProjectsLocationsDataStoresBranchesDocumentsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -6019,7 +6194,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsGetCall) Do(opts ...googlea // ], // "parameters": { // "name": { - // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.", + // "description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", // "required": true, @@ -6203,7 +6378,7 @@ type ProjectsLocationsDataStoresBranchesDocumentsListCall struct { // the branch ID, to list documents under the default branch. If the // caller does not have permission to list Documentss under this // branch, regardless of whether or not this branch exists, a -// PERMISSION_DENIED error is returned. +// `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsDataStoresBranchesDocumentsListCall { c := &ProjectsLocationsDataStoresBranchesDocumentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -6213,7 +6388,7 @@ func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string // PageSize sets the optional parameter "pageSize": Maximum number of // Documents to return. If unspecified, defaults to 100. The maximum // allowed value is 1000. Values above 1000 will be coerced to 1000. If -// this field is negative, an INVALID_ARGUMENT error is returned. +// this field is negative, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize(pageSize int64) *ProjectsLocationsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -6224,7 +6399,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageSize(pageSize // DocumentService.ListDocuments call. Provide this to retrieve the // subsequent page. When paginating, all other parameters provided to // DocumentService.ListDocuments must match the call that provided the -// page token. Otherwise, an INVALID_ARGUMENT error is returned. +// page token. Otherwise, an `INVALID_ARGUMENT` error is returned. func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) PageToken(pageToken string) *ProjectsLocationsDataStoresBranchesDocumentsListCall { c.urlParams_.Set("pageToken", pageToken) return c @@ -6340,18 +6515,18 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Do(opts ...google // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.", + // "description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + // "description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", // "location": "query", // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -7630,8 +7805,8 @@ type ProjectsLocationsDataStoresServingConfigsRecommendCall struct { // event. // // - servingConfig: Full resource name of the format: -// projects/*/locations/global/collections/*/dataStores/*/servingConfig -// s/* Before you can request recommendations from your model, you +// `projects/*/locations/global/collections/*/dataStores/*/servingConfi +// gs/*` Before you can request recommendations from your model, you // must create at least one serving config for it. func (r *ProjectsLocationsDataStoresServingConfigsService) Recommend(servingConfig string, googleclouddiscoveryenginev1betarecommendrequest *GoogleCloudDiscoveryengineV1betaRecommendRequest) *ProjectsLocationsDataStoresServingConfigsRecommendCall { c := &ProjectsLocationsDataStoresServingConfigsRecommendCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7742,7 +7917,7 @@ func (c *ProjectsLocationsDataStoresServingConfigsRecommendCall) Do(opts ...goog // ], // "parameters": { // "servingConfig": { - // "description": "Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.", + // "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", // "required": true, diff --git a/documentai/v1/documentai-api.json b/documentai/v1/documentai-api.json index 045e8828099..fb77cb971a4 100644 --- a/documentai/v1/documentai-api.json +++ b/documentai/v1/documentai-api.json @@ -139,7 +139,7 @@ "locations": { "methods": { "fetchProcessorTypes": { - "description": "Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.", + "description": "Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes", "httpMethod": "GET", "id": "documentai.projects.locations.fetchProcessorTypes", @@ -976,7 +976,7 @@ ], "parameters": { "pageSize": { - "description": "The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "description": "The standard list page size. If unspecified, at most `5` evaluations will be returned. The maximum value is `100`; values above `100` will be coerced to `100`.", "format": "int32", "location": "query", "type": "integer" @@ -1042,7 +1042,7 @@ } } }, - "revision": "20230323", + "revision": "20230420", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -1253,56 +1253,56 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for CreateLabelerPool.", + "description": "The long-running operation metadata for CreateLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for DeleteLabelerPool.", + "description": "The long-running operation metadata for DeleteLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1314,12 +1314,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1360,12 +1360,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1382,13 +1382,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -1569,12 +1569,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { - "description": "The long running operation metadata for the ImportProcessorVersion method.", + "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata for the long running operation." + "description": "The basic metadata for the long-running operation." } }, "type": "object" @@ -1707,12 +1707,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1729,7 +1729,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", @@ -1774,7 +1774,7 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -1785,12 +1785,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1812,23 +1812,23 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { - "description": "The long running operation metadata for updating the human review configuration.", + "description": "The long-running operation metadata for updating the human review configuration.", "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for UpdateLabelerPool.", + "description": "The long-running operation metadata for UpdateLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1868,7 +1868,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessMetadata": { - "description": "The long running operation metadata for batch process method.", + "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", "properties": { "createTime": { @@ -1941,7 +1941,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessRequest": { - "description": "Request message for batch process document method.", + "description": "Request message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessRequest", "properties": { "documentOutputConfig": { @@ -1960,7 +1960,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessResponse": { - "description": "Response message for batch process document method.", + "description": "Response message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessResponse", "properties": {}, "type": "object" @@ -2032,34 +2032,34 @@ "type": "object" }, "GoogleCloudDocumentaiV1DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -2077,12 +2077,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiV1DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -2915,6 +2915,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -2942,6 +2946,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1DocumentPageVisualElement", @@ -3356,12 +3431,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -3384,7 +3459,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -3401,7 +3476,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -3690,7 +3765,7 @@ "id": "GoogleCloudDocumentaiV1HumanReviewStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "state": { @@ -3704,10 +3779,10 @@ ], "enumDescriptions": [ "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review is not enabled on the processor or the processing request has been set to skip this document.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", "Human review validation is triggered and passed, so no review is needed.", "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the [state_message] for details." + "Some error happened during triggering human review, see the state_message for details." ], "type": "string" }, @@ -3719,7 +3794,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1ListEvaluationsResponse": { - "description": "The response from ListEvaluations.", + "description": "The response from `ListEvaluations`.", "id": "GoogleCloudDocumentaiV1ListEvaluationsResponse", "properties": { "evaluations": { @@ -3812,7 +3887,7 @@ "id": "GoogleCloudDocumentaiV1ProcessRequest", "properties": { "fieldMask": { - "description": "Specifies which fields to include in ProcessResponse's document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", + "description": "Specifies which fields to include in the `ProcessResponse` Document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", "format": "google-fieldmask", "type": "string" }, @@ -3903,7 +3978,7 @@ "type": "string" }, "type": { - "description": "The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a list of processors types, see FetchProcessorTypes.", + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", "type": "string" } }, @@ -3964,7 +4039,7 @@ "type": "array" }, "type": { - "description": "The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.", + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.", "type": "string" } }, @@ -4084,12 +4159,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { - "description": "The long running operation metadata for review document method.", + "description": "The long-running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "questionId": { "description": "The Crowd Compute question ID.", @@ -4159,12 +4234,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -4192,7 +4267,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", @@ -4275,7 +4350,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -4286,12 +4361,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -5147,6 +5222,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -5174,6 +5253,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement", @@ -6450,6 +6600,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -6477,6 +6631,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement", @@ -6910,7 +7135,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { - "description": "The long running operation metadata for batch process method.", + "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", "properties": { "createTime": { @@ -6964,7 +7189,7 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.", + "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument method.", "type": "string" }, "humanReviewStatus": { @@ -6987,7 +7212,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessResponse": { - "description": "Response message for batch process document method.", + "description": "Response message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse", "properties": {}, "type": "object" @@ -7038,34 +7263,34 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7077,12 +7302,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7094,12 +7319,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7116,13 +7341,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -7137,7 +7362,7 @@ "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "state": { @@ -7151,10 +7376,10 @@ ], "enumDescriptions": [ "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review is not enabled on the processor or the processing request has been set to skip this document.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", "Human review validation is triggered and passed, so no review is needed.", "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the [state_message] for details." + "Some error happened during triggering human review, see the state_message for details." ], "type": "string" }, @@ -7166,12 +7391,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { - "description": "The long running operation metadata for the ImportProcessorVersion method.", + "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata for the long running operation." + "description": "The basic metadata for the long-running operation." } }, "type": "object" @@ -7188,12 +7413,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": { - "description": "The long running operation metadata for review document method.", + "description": "The long-running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "createTime": { "description": "The creation time of the operation.", @@ -7266,12 +7491,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7288,7 +7513,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation", @@ -7333,7 +7558,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -7344,12 +7569,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7379,7 +7604,7 @@ "type": "object" }, "GoogleCloudLocationLocation": { - "description": "A resource that represents Google Cloud Platform location.", + "description": "A resource that represents a Google Cloud location.", "id": "GoogleCloudLocationLocation", "properties": { "displayName": { diff --git a/documentai/v1/documentai-gen.go b/documentai/v1/documentai-gen.go index 5296d170b10..6b7d547934e 100644 --- a/documentai/v1/documentai-gen.go +++ b/documentai/v1/documentai-gen.go @@ -549,9 +549,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata) MarshalJSON() ([ } // GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: The -// long running operation metadata for CreateLabelerPool. +// long-running operation metadata for CreateLabelerPool. type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -579,9 +579,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata) Marsh } // GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: The -// long running operation metadata for DeleteLabelerPool. +// long-running operation metadata for DeleteLabelerPool. type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -608,10 +608,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata) Marsh return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The long -// running operation metadata for delete processor method. +// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The +// long-running operation metadata for delete processor method. type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -639,9 +639,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata) MarshalJSON() ([ } // GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: The -// long running operation metadata for delete processor version method. +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -669,9 +669,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata) MarshalJS } // GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: The -// long running operation metadata for deploy processor version method. +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -703,10 +703,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata) MarshalJS type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The long -// running operation metadata for disable processor method. +// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The +// long-running operation metadata for disable processor method. type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -804,10 +804,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId) MarshalJS return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The long -// running operation metadata for enable processor method. +// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The +// long-running operation metadata for enable processor method. type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -843,7 +843,7 @@ type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse struct { // GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: // Metadata of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -871,7 +871,7 @@ func (s *GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata) Marshal } // GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: -// Metadata of the EvaluateProcessorVersion method. +// Response of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` @@ -1200,10 +1200,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse struct { } // GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: The -// long running operation metadata for the ImportProcessorVersion +// long-running operation metadata for the ImportProcessorVersion // method. type GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long running operation. + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1442,10 +1442,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3RevisionRef) MarshalJSON() ([]byte, error } // GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: The -// long running operation metadata for set default processor version +// long-running operation metadata for set default processor version // method. type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1480,7 +1480,7 @@ type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: The // metadata that represents a processor version being created. type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -1559,7 +1559,7 @@ func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValid } // GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: The -// response for the TrainProcessorVersion method. +// response for TrainProcessorVersion. type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -1590,10 +1590,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse) MarshalJSO } // GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: The -// long running operation metadata for the undeploy processor version +// long-running operation metadata for the undeploy processor version // method. type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1654,10 +1654,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata) MarshalJS } // GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: The -// long running operation metadata for updating the human review +// long-running operation metadata for updating the human review // configuration. type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1685,9 +1685,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata) MarshalJ } // GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: The -// long running operation metadata for UpdateLabelerPool. +// long-running operation metadata for UpdateLabelerPool. type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1796,8 +1796,8 @@ func (s *GoogleCloudDocumentaiV1BatchDocumentsInputConfig) MarshalJSON() ([]byte return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1BatchProcessMetadata: The long running -// operation metadata for batch process method. +// GoogleCloudDocumentaiV1BatchProcessMetadata: The long-running +// operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,omitempty"` @@ -1896,8 +1896,8 @@ func (s *GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus) Mar return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1BatchProcessRequest: Request message for batch -// process document method. +// GoogleCloudDocumentaiV1BatchProcessRequest: Request message for +// BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessRequest struct { // DocumentOutputConfig: The overall output config for batch process. DocumentOutputConfig *GoogleCloudDocumentaiV1DocumentOutputConfig `json:"documentOutputConfig,omitempty"` @@ -1935,7 +1935,7 @@ func (s *GoogleCloudDocumentaiV1BatchProcessRequest) MarshalJSON() ([]byte, erro } // GoogleCloudDocumentaiV1BatchProcessResponse: Response message for -// batch process document method. +// BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessResponse struct { } @@ -2022,10 +2022,10 @@ func (s *GoogleCloudDocumentaiV1CommonOperationMetadata) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long running +// GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long-running // operation metadata for delete processor method. type GoogleCloudDocumentaiV1DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2052,10 +2052,10 @@ func (s *GoogleCloudDocumentaiV1DeleteProcessorMetadata) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The long -// running operation metadata for delete processor version method. +// GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2082,10 +2082,10 @@ func (s *GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The long -// running operation metadata for deploy processor version method. +// GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiV1DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2122,10 +2122,10 @@ type GoogleCloudDocumentaiV1DeployProcessorVersionRequest struct { type GoogleCloudDocumentaiV1DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiV1DisableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1DisableProcessorMetadata: The long-running // operation metadata for disable processor method. type GoogleCloudDocumentaiV1DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -3433,6 +3433,9 @@ type GoogleCloudDocumentaiV1DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -3492,6 +3495,96 @@ func (s *GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: Font and other +// text style attributes. +type GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1DocumentPageVisualElement: Detected non-text // visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1DocumentPageVisualElement struct { @@ -4182,10 +4275,10 @@ func (s *GoogleCloudDocumentaiV1DocumentTextChange) MarshalJSON() ([]byte, error return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1EnableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1EnableProcessorMetadata: The long-running // operation metadata for enable processor method. type GoogleCloudDocumentaiV1EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -4226,7 +4319,7 @@ type GoogleCloudDocumentaiV1EnableProcessorResponse struct { // GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: Metadata of // the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -4284,7 +4377,7 @@ func (s *GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest) MarshalJSON() ( return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Metadata of +// GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Response of // the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. @@ -4794,10 +4887,9 @@ func (s *GoogleCloudDocumentaiV1GcsPrefix) MarshalJSON() ([]byte, error) { // on a processed document. type GoogleCloudDocumentaiV1HumanReviewStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. This field is populated only when the [state] is - // [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and - // metadata as the long running operation returned by [ReviewDocument] - // method. + // processed document. This field is populated only when the state is + // `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + // metadata as the long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // State: The state of human review on the processing request. @@ -4806,14 +4898,14 @@ type GoogleCloudDocumentaiV1HumanReviewStatus struct { // "STATE_UNSPECIFIED" - Human review state is unspecified. Most // likely due to an internal error. // "SKIPPED" - Human review is skipped for the document. This can - // happen because human review is not enabled on the processor or the + // happen because human review isn't enabled on the processor or the // processing request has been set to skip this document. // "VALIDATION_PASSED" - Human review validation is triggered and // passed, so no review is needed. // "IN_PROGRESS" - Human review validation is triggered and the // document is under review. // "ERROR" - Some error happened during triggering human review, see - // the [state_message] for details. + // the state_message for details. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review @@ -4846,7 +4938,7 @@ func (s *GoogleCloudDocumentaiV1HumanReviewStatus) MarshalJSON() ([]byte, error) } // GoogleCloudDocumentaiV1ListEvaluationsResponse: The response from -// ListEvaluations. +// `ListEvaluations`. type GoogleCloudDocumentaiV1ListEvaluationsResponse struct { // Evaluations: The evaluations requested. Evaluations []*GoogleCloudDocumentaiV1Evaluation `json:"evaluations,omitempty"` @@ -5043,8 +5135,8 @@ func (s *GoogleCloudDocumentaiV1NormalizedVertex) UnmarshalJSON(data []byte) err // GoogleCloudDocumentaiV1ProcessRequest: Request message for the // process document method. type GoogleCloudDocumentaiV1ProcessRequest struct { - // FieldMask: Specifies which fields to include in ProcessResponse's - // document. Only supports top level document and pages field so it must + // FieldMask: Specifies which fields to include in the `ProcessResponse` + // Document. Only supports top level document and pages field so it must // be in the form of `{document_field_name}` or // `pages.{page_field_name}`. FieldMask string `json:"fieldMask,omitempty"` @@ -5171,8 +5263,9 @@ type GoogleCloudDocumentaiV1Processor struct { // successful. State string `json:"state,omitempty"` - // Type: The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, - // etc. To get a list of processors types, see FetchProcessorTypes. + // Type: The processor type, such as: `OCR_PROCESSOR`, + // `INVOICE_PROCESSOR`. To get a list of processor types, see + // FetchProcessorTypes. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -5264,8 +5357,8 @@ type GoogleCloudDocumentaiV1ProcessorType struct { // for this processor. SampleDocumentUris []string `json:"sampleDocumentUris,omitempty"` - // Type: The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, - // etc. + // Type: The processor type, such as: `OCR_PROCESSOR`, + // `INVOICE_PROCESSOR`. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -5477,10 +5570,10 @@ func (s *GoogleCloudDocumentaiV1RawDocument) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The long -// running operation metadata for review document method. +// GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The +// long-running operation metadata for review document method. type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // QuestionId: The Crowd Compute question ID. @@ -5599,10 +5692,11 @@ func (s *GoogleCloudDocumentaiV1ReviewDocumentResponse) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The long -// running operation metadata for set default processor version method. +// GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The +// long-running operation metadata for set default processor version +// method. type GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -5671,7 +5765,7 @@ type GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: The metadata // that represents a processor version being created. type GoogleCloudDocumentaiV1TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -5830,7 +5924,7 @@ func (s *GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData) MarshalJS } // GoogleCloudDocumentaiV1TrainProcessorVersionResponse: The response -// for the TrainProcessorVersion method. +// for TrainProcessorVersion. type GoogleCloudDocumentaiV1TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -5860,10 +5954,11 @@ func (s *GoogleCloudDocumentaiV1TrainProcessorVersionResponse) MarshalJSON() ([] return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The long -// running operation metadata for the undeploy processor version method. +// GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The +// long-running operation metadata for the undeploy processor version +// method. type GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7215,6 +7310,9 @@ type GoogleCloudDocumentaiV1beta1DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -7274,6 +7372,96 @@ func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta1DocumentPageVisualElement struct { @@ -9387,6 +9575,9 @@ type GoogleCloudDocumentaiV1beta2DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -9446,6 +9637,96 @@ func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta2DocumentPageVisualElement struct { @@ -10225,8 +10506,8 @@ func (s *GoogleCloudDocumentaiV1beta2Vertex) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long running -// operation metadata for batch process method. +// GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long-running +// operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,omitempty"` @@ -10283,9 +10564,9 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadata) MarshalJSON() ([]byte // s: The status of a each individual document in the batch process. type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. If the human review process is not triggered, - // this field will be empty. It has the same response type and metadata - // as the long running operation returned by ReviewDocument method. + // processed document. If the human review process isn't triggered, this + // field will be empty. It has the same response type and metadata as + // the long-running operation returned by ReviewDocument method. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // HumanReviewStatus: The status of human review on the processed @@ -10333,7 +10614,7 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus } // GoogleCloudDocumentaiV1beta3BatchProcessResponse: Response message -// for batch process document method. +// for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessResponse struct { } @@ -10387,10 +10668,10 @@ func (s *GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long running +// GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long-running // operation metadata for delete processor method. type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10417,10 +10698,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The long -// running operation metadata for delete processor version method. +// GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10447,10 +10728,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The long -// running operation metadata for deploy processor version method. +// GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10482,10 +10763,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata) MarshalJSON type GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The long -// running operation metadata for disable processor method. +// GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The +// long-running operation metadata for disable processor method. type GoogleCloudDocumentaiV1beta3DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10518,10 +10799,10 @@ func (s *GoogleCloudDocumentaiV1beta3DisableProcessorMetadata) MarshalJSON() ([] type GoogleCloudDocumentaiV1beta3DisableProcessorResponse struct { } -// GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long-running // operation metadata for enable processor method. type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10557,7 +10838,7 @@ type GoogleCloudDocumentaiV1beta3EnableProcessorResponse struct { // GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: // Metadata of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10585,7 +10866,7 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata) MarshalJS } // GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: -// Metadata of the EvaluateProcessorVersion method. +// Response of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` @@ -10617,10 +10898,9 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse) MarshalJS // review on a processed document. type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. This field is populated only when the [state] is - // [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and - // metadata as the long running operation returned by [ReviewDocument] - // method. + // processed document. This field is populated only when the state is + // `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + // metadata as the long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // State: The state of human review on the processing request. @@ -10629,14 +10909,14 @@ type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { // "STATE_UNSPECIFIED" - Human review state is unspecified. Most // likely due to an internal error. // "SKIPPED" - Human review is skipped for the document. This can - // happen because human review is not enabled on the processor or the + // happen because human review isn't enabled on the processor or the // processing request has been set to skip this document. // "VALIDATION_PASSED" - Human review validation is triggered and // passed, so no review is needed. // "IN_PROGRESS" - Human review validation is triggered and the // document is under review. // "ERROR" - Some error happened during triggering human review, see - // the [state_message] for details. + // the state_message for details. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review @@ -10668,10 +10948,11 @@ func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The long -// running operation metadata for the ImportProcessorVersion method. +// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The +// long-running operation metadata for the ImportProcessorVersion +// method. type GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long running operation. + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10728,10 +11009,10 @@ func (s *GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The long -// running operation metadata for review document method. +// GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The +// long-running operation metadata for review document method. type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // CreateTime: The creation time of the operation. @@ -10827,10 +11108,10 @@ func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]by } // GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: The -// long running operation metadata for set default processor version +// long-running operation metadata for set default processor version // method. type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10865,7 +11146,7 @@ type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: The // metadata that represents a processor version being created. type GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -10944,7 +11225,7 @@ func (s *GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidat } // GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: The -// response for the TrainProcessorVersion method. +// response for TrainProcessorVersion. type GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -10975,10 +11256,10 @@ func (s *GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse) MarshalJSON( } // GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: The -// long running operation metadata for the undeploy processor version +// long-running operation metadata for the undeploy processor version // method. type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -11047,8 +11328,8 @@ func (s *GoogleCloudLocationListLocationsResponse) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudLocationLocation: A resource that represents Google Cloud -// Platform location. +// GoogleCloudLocationLocation: A resource that represents a Google +// Cloud location. type GoogleCloudLocationLocation struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". @@ -11840,8 +12121,8 @@ type ProjectsLocationsFetchProcessorTypesCall struct { header_ http.Header } -// FetchProcessorTypes: Fetches processor types. Note that we do not use -// ListProcessorTypes here because it is not paginated. +// FetchProcessorTypes: Fetches processor types. Note that we don't use +// ListProcessorTypes here, because it isn't paginated. // // - parent: The project of processor type to list. The available // processor types may depend on the allow-listing on projects. @@ -11953,7 +12234,7 @@ func (c *ProjectsLocationsFetchProcessorTypesCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.", + // "description": "Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes", // "httpMethod": "GET", // "id": "documentai.projects.locations.fetchProcessorTypes", @@ -16194,8 +16475,9 @@ func (r *ProjectsLocationsProcessorsProcessorVersionsEvaluationsService) List(pa } // PageSize sets the optional parameter "pageSize": The standard list -// page size. If unspecified, at most 5 evaluations will be returned. -// The maximum value is 100; values above 100 will be coerced to 100. +// page size. If unspecified, at most `5` evaluations will be returned. +// The maximum value is `100`; values above `100` will be coerced to +// `100`. func (c *ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall) PageSize(pageSize int64) *ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -16319,7 +16601,7 @@ func (c *ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall) Do(opt // ], // "parameters": { // "pageSize": { - // "description": "The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + // "description": "The standard list page size. If unspecified, at most `5` evaluations will be returned. The maximum value is `100`; values above `100` will be coerced to `100`.", // "format": "int32", // "location": "query", // "type": "integer" diff --git a/documentai/v1beta2/documentai-api.json b/documentai/v1beta2/documentai-api.json index 059cc7988fb..cd98a105165 100644 --- a/documentai/v1beta2/documentai-api.json +++ b/documentai/v1beta2/documentai-api.json @@ -292,7 +292,7 @@ } } }, - "revision": "20230310", + "revision": "20230420", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -503,56 +503,56 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for CreateLabelerPool.", + "description": "The long-running operation metadata for CreateLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for DeleteLabelerPool.", + "description": "The long-running operation metadata for DeleteLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -564,12 +564,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -610,12 +610,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -632,13 +632,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -819,12 +819,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { - "description": "The long running operation metadata for the ImportProcessorVersion method.", + "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata for the long running operation." + "description": "The basic metadata for the long-running operation." } }, "type": "object" @@ -957,12 +957,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -979,7 +979,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", @@ -1024,7 +1024,7 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -1035,12 +1035,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1062,29 +1062,29 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { - "description": "The long running operation metadata for updating the human review configuration.", + "description": "The long-running operation metadata for updating the human review configuration.", "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for UpdateLabelerPool.", + "description": "The long-running operation metadata for UpdateLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessMetadata": { - "description": "The long running operation metadata for batch process method.", + "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", "properties": { "createTime": { @@ -1157,7 +1157,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessResponse": { - "description": "Response message for batch process document method.", + "description": "Response message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessResponse", "properties": {}, "type": "object" @@ -1208,34 +1208,34 @@ "type": "object" }, "GoogleCloudDocumentaiV1DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1247,12 +1247,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiV1DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1264,12 +1264,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1286,13 +1286,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -1307,7 +1307,7 @@ "id": "GoogleCloudDocumentaiV1HumanReviewStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "state": { @@ -1321,10 +1321,10 @@ ], "enumDescriptions": [ "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review is not enabled on the processor or the processing request has been set to skip this document.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", "Human review validation is triggered and passed, so no review is needed.", "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the [state_message] for details." + "Some error happened during triggering human review, see the state_message for details." ], "type": "string" }, @@ -1336,12 +1336,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { - "description": "The long running operation metadata for review document method.", + "description": "The long-running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "questionId": { "description": "The Crowd Compute question ID.", @@ -1380,12 +1380,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1402,7 +1402,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", @@ -1447,7 +1447,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -1458,12 +1458,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -2296,6 +2296,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -2323,6 +2327,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement", @@ -3624,6 +3699,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -3651,6 +3730,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement", @@ -4241,7 +4391,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { - "description": "The long running operation metadata for batch process method.", + "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", "properties": { "createTime": { @@ -4295,7 +4445,7 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.", + "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument method.", "type": "string" }, "humanReviewStatus": { @@ -4318,7 +4468,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessResponse": { - "description": "Response message for batch process document method.", + "description": "Response message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse", "properties": {}, "type": "object" @@ -4369,34 +4519,34 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -4408,12 +4558,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -4425,12 +4575,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -4447,13 +4597,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -4468,7 +4618,7 @@ "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "state": { @@ -4482,10 +4632,10 @@ ], "enumDescriptions": [ "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review is not enabled on the processor or the processing request has been set to skip this document.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", "Human review validation is triggered and passed, so no review is needed.", "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the [state_message] for details." + "Some error happened during triggering human review, see the state_message for details." ], "type": "string" }, @@ -4497,12 +4647,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { - "description": "The long running operation metadata for the ImportProcessorVersion method.", + "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata for the long running operation." + "description": "The basic metadata for the long-running operation." } }, "type": "object" @@ -4519,12 +4669,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": { - "description": "The long running operation metadata for review document method.", + "description": "The long-running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "createTime": { "description": "The creation time of the operation.", @@ -4597,12 +4747,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -4619,7 +4769,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation", @@ -4664,7 +4814,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -4675,12 +4825,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" diff --git a/documentai/v1beta2/documentai-gen.go b/documentai/v1beta2/documentai-gen.go index 396656c9ae4..c509ce9d941 100644 --- a/documentai/v1beta2/documentai-gen.go +++ b/documentai/v1beta2/documentai-gen.go @@ -501,9 +501,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata) MarshalJSON() ([ } // GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: The -// long running operation metadata for CreateLabelerPool. +// long-running operation metadata for CreateLabelerPool. type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -531,9 +531,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata) Marsh } // GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: The -// long running operation metadata for DeleteLabelerPool. +// long-running operation metadata for DeleteLabelerPool. type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -560,10 +560,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata) Marsh return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The long -// running operation metadata for delete processor method. +// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The +// long-running operation metadata for delete processor method. type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -591,9 +591,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata) MarshalJSON() ([ } // GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: The -// long running operation metadata for delete processor version method. +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -621,9 +621,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata) MarshalJS } // GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: The -// long running operation metadata for deploy processor version method. +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -655,10 +655,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata) MarshalJS type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The long -// running operation metadata for disable processor method. +// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The +// long-running operation metadata for disable processor method. type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -756,10 +756,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId) MarshalJS return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The long -// running operation metadata for enable processor method. +// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The +// long-running operation metadata for enable processor method. type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -795,7 +795,7 @@ type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse struct { // GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: // Metadata of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -823,7 +823,7 @@ func (s *GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata) Marshal } // GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: -// Metadata of the EvaluateProcessorVersion method. +// Response of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` @@ -1152,10 +1152,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse struct { } // GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: The -// long running operation metadata for the ImportProcessorVersion +// long-running operation metadata for the ImportProcessorVersion // method. type GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long running operation. + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1394,10 +1394,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3RevisionRef) MarshalJSON() ([]byte, error } // GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: The -// long running operation metadata for set default processor version +// long-running operation metadata for set default processor version // method. type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1432,7 +1432,7 @@ type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: The // metadata that represents a processor version being created. type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -1511,7 +1511,7 @@ func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValid } // GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: The -// response for the TrainProcessorVersion method. +// response for TrainProcessorVersion. type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -1542,10 +1542,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse) MarshalJSO } // GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: The -// long running operation metadata for the undeploy processor version +// long-running operation metadata for the undeploy processor version // method. type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1606,10 +1606,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata) MarshalJS } // GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: The -// long running operation metadata for updating the human review +// long-running operation metadata for updating the human review // configuration. type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1637,9 +1637,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata) MarshalJ } // GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: The -// long running operation metadata for UpdateLabelerPool. +// long-running operation metadata for UpdateLabelerPool. type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1666,8 +1666,8 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata) Marsh return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1BatchProcessMetadata: The long running -// operation metadata for batch process method. +// GoogleCloudDocumentaiV1BatchProcessMetadata: The long-running +// operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,omitempty"` @@ -1767,7 +1767,7 @@ func (s *GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus) Mar } // GoogleCloudDocumentaiV1BatchProcessResponse: Response message for -// batch process document method. +// BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessResponse struct { } @@ -1821,10 +1821,10 @@ func (s *GoogleCloudDocumentaiV1CommonOperationMetadata) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long running +// GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long-running // operation metadata for delete processor method. type GoogleCloudDocumentaiV1DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1851,10 +1851,10 @@ func (s *GoogleCloudDocumentaiV1DeleteProcessorMetadata) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The long -// running operation metadata for delete processor version method. +// GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1881,10 +1881,10 @@ func (s *GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The long -// running operation metadata for deploy processor version method. +// GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiV1DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1916,10 +1916,10 @@ func (s *GoogleCloudDocumentaiV1DeployProcessorVersionMetadata) MarshalJSON() ([ type GoogleCloudDocumentaiV1DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiV1DisableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1DisableProcessorMetadata: The long-running // operation metadata for disable processor method. type GoogleCloudDocumentaiV1DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1952,10 +1952,10 @@ func (s *GoogleCloudDocumentaiV1DisableProcessorMetadata) MarshalJSON() ([]byte, type GoogleCloudDocumentaiV1DisableProcessorResponse struct { } -// GoogleCloudDocumentaiV1EnableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1EnableProcessorMetadata: The long-running // operation metadata for enable processor method. type GoogleCloudDocumentaiV1EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1991,7 +1991,7 @@ type GoogleCloudDocumentaiV1EnableProcessorResponse struct { // GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: Metadata of // the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2018,7 +2018,7 @@ func (s *GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata) MarshalJSON() return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Metadata of +// GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Response of // the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. @@ -2051,10 +2051,9 @@ func (s *GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse) MarshalJSON() // on a processed document. type GoogleCloudDocumentaiV1HumanReviewStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. This field is populated only when the [state] is - // [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and - // metadata as the long running operation returned by [ReviewDocument] - // method. + // processed document. This field is populated only when the state is + // `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + // metadata as the long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // State: The state of human review on the processing request. @@ -2063,14 +2062,14 @@ type GoogleCloudDocumentaiV1HumanReviewStatus struct { // "STATE_UNSPECIFIED" - Human review state is unspecified. Most // likely due to an internal error. // "SKIPPED" - Human review is skipped for the document. This can - // happen because human review is not enabled on the processor or the + // happen because human review isn't enabled on the processor or the // processing request has been set to skip this document. // "VALIDATION_PASSED" - Human review validation is triggered and // passed, so no review is needed. // "IN_PROGRESS" - Human review validation is triggered and the // document is under review. // "ERROR" - Some error happened during triggering human review, see - // the [state_message] for details. + // the state_message for details. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review @@ -2102,10 +2101,10 @@ func (s *GoogleCloudDocumentaiV1HumanReviewStatus) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The long -// running operation metadata for review document method. +// GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The +// long-running operation metadata for review document method. type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // QuestionId: The Crowd Compute question ID. @@ -2178,10 +2177,11 @@ func (s *GoogleCloudDocumentaiV1ReviewDocumentResponse) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The long -// running operation metadata for set default processor version method. +// GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The +// long-running operation metadata for set default processor version +// method. type GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2216,7 +2216,7 @@ type GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: The metadata // that represents a processor version being created. type GoogleCloudDocumentaiV1TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -2297,7 +2297,7 @@ func (s *GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation) } // GoogleCloudDocumentaiV1TrainProcessorVersionResponse: The response -// for the TrainProcessorVersion method. +// for TrainProcessorVersion. type GoogleCloudDocumentaiV1TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -2327,10 +2327,11 @@ func (s *GoogleCloudDocumentaiV1TrainProcessorVersionResponse) MarshalJSON() ([] return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The long -// running operation metadata for the undeploy processor version method. +// GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The +// long-running operation metadata for the undeploy processor version +// method. type GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -3644,6 +3645,9 @@ type GoogleCloudDocumentaiV1beta1DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -3703,6 +3707,96 @@ func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta1DocumentPageVisualElement struct { @@ -5880,6 +5974,9 @@ type GoogleCloudDocumentaiV1beta2DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -5939,6 +6036,96 @@ func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta2DocumentPageVisualElement struct { @@ -7005,8 +7192,8 @@ func (s *GoogleCloudDocumentaiV1beta2Vertex) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long running -// operation metadata for batch process method. +// GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long-running +// operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,omitempty"` @@ -7063,9 +7250,9 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadata) MarshalJSON() ([]byte // s: The status of a each individual document in the batch process. type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. If the human review process is not triggered, - // this field will be empty. It has the same response type and metadata - // as the long running operation returned by ReviewDocument method. + // processed document. If the human review process isn't triggered, this + // field will be empty. It has the same response type and metadata as + // the long-running operation returned by ReviewDocument method. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // HumanReviewStatus: The status of human review on the processed @@ -7113,7 +7300,7 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus } // GoogleCloudDocumentaiV1beta3BatchProcessResponse: Response message -// for batch process document method. +// for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessResponse struct { } @@ -7167,10 +7354,10 @@ func (s *GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long running +// GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long-running // operation metadata for delete processor method. type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7197,10 +7384,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The long -// running operation metadata for delete processor version method. +// GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7227,10 +7414,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The long -// running operation metadata for deploy processor version method. +// GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7262,10 +7449,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata) MarshalJSON type GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The long -// running operation metadata for disable processor method. +// GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The +// long-running operation metadata for disable processor method. type GoogleCloudDocumentaiV1beta3DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7298,10 +7485,10 @@ func (s *GoogleCloudDocumentaiV1beta3DisableProcessorMetadata) MarshalJSON() ([] type GoogleCloudDocumentaiV1beta3DisableProcessorResponse struct { } -// GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long-running // operation metadata for enable processor method. type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7337,7 +7524,7 @@ type GoogleCloudDocumentaiV1beta3EnableProcessorResponse struct { // GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: // Metadata of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7365,7 +7552,7 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata) MarshalJS } // GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: -// Metadata of the EvaluateProcessorVersion method. +// Response of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` @@ -7397,10 +7584,9 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse) MarshalJS // review on a processed document. type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. This field is populated only when the [state] is - // [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and - // metadata as the long running operation returned by [ReviewDocument] - // method. + // processed document. This field is populated only when the state is + // `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + // metadata as the long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // State: The state of human review on the processing request. @@ -7409,14 +7595,14 @@ type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { // "STATE_UNSPECIFIED" - Human review state is unspecified. Most // likely due to an internal error. // "SKIPPED" - Human review is skipped for the document. This can - // happen because human review is not enabled on the processor or the + // happen because human review isn't enabled on the processor or the // processing request has been set to skip this document. // "VALIDATION_PASSED" - Human review validation is triggered and // passed, so no review is needed. // "IN_PROGRESS" - Human review validation is triggered and the // document is under review. // "ERROR" - Some error happened during triggering human review, see - // the [state_message] for details. + // the state_message for details. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review @@ -7448,10 +7634,11 @@ func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The long -// running operation metadata for the ImportProcessorVersion method. +// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The +// long-running operation metadata for the ImportProcessorVersion +// method. type GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long running operation. + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7508,10 +7695,10 @@ func (s *GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The long -// running operation metadata for review document method. +// GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The +// long-running operation metadata for review document method. type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // CreateTime: The creation time of the operation. @@ -7607,10 +7794,10 @@ func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]by } // GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: The -// long running operation metadata for set default processor version +// long-running operation metadata for set default processor version // method. type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7645,7 +7832,7 @@ type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: The // metadata that represents a processor version being created. type GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -7724,7 +7911,7 @@ func (s *GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidat } // GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: The -// response for the TrainProcessorVersion method. +// response for TrainProcessorVersion. type GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -7755,10 +7942,10 @@ func (s *GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse) MarshalJSON( } // GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: The -// long running operation metadata for the undeploy processor version +// long-running operation metadata for the undeploy processor version // method. type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to diff --git a/documentai/v1beta3/documentai-api.json b/documentai/v1beta3/documentai-api.json index dcede92a70b..5c9334eac97 100644 --- a/documentai/v1beta3/documentai-api.json +++ b/documentai/v1beta3/documentai-api.json @@ -110,7 +110,7 @@ "locations": { "methods": { "fetchProcessorTypes": { - "description": "Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.", + "description": "Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.", "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes", "httpMethod": "GET", "id": "documentai.projects.locations.fetchProcessorTypes", @@ -975,7 +975,7 @@ ], "parameters": { "pageSize": { - "description": "The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "description": "The standard list page size. If unspecified, at most `5` evaluations will be returned. The maximum value is `100`; values above `100` will be coerced to `100`.", "format": "int32", "location": "query", "type": "integer" @@ -1012,7 +1012,7 @@ } } }, - "revision": "20230417", + "revision": "20230420", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -1223,56 +1223,56 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for CreateLabelerPool.", + "description": "The long-running operation metadata for CreateLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for DeleteLabelerPool.", + "description": "The long-running operation metadata for DeleteLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1284,12 +1284,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1330,12 +1330,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1352,13 +1352,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -1539,12 +1539,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { - "description": "The long running operation metadata for the ImportProcessorVersion method.", + "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata for the long running operation." + "description": "The basic metadata for the long-running operation." } }, "type": "object" @@ -1677,12 +1677,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1699,7 +1699,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", @@ -1744,7 +1744,7 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -1755,12 +1755,12 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1782,29 +1782,29 @@ "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { - "description": "The long running operation metadata for updating the human review configuration.", + "description": "The long-running operation metadata for updating the human review configuration.", "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for UpdateLabelerPool.", + "description": "The long-running operation metadata for UpdateLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessMetadata": { - "description": "The long running operation metadata for batch process method.", + "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", "properties": { "createTime": { @@ -1877,7 +1877,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1BatchProcessResponse": { - "description": "Response message for batch process document method.", + "description": "Response message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessResponse", "properties": {}, "type": "object" @@ -1928,34 +1928,34 @@ "type": "object" }, "GoogleCloudDocumentaiV1DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1967,12 +1967,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiV1DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -1984,12 +1984,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -2006,13 +2006,13 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -2027,7 +2027,7 @@ "id": "GoogleCloudDocumentaiV1HumanReviewStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "state": { @@ -2041,10 +2041,10 @@ ], "enumDescriptions": [ "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review is not enabled on the processor or the processing request has been set to skip this document.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", "Human review validation is triggered and passed, so no review is needed.", "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the [state_message] for details." + "Some error happened during triggering human review, see the state_message for details." ], "type": "string" }, @@ -2056,12 +2056,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { - "description": "The long running operation metadata for review document method.", + "description": "The long-running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "questionId": { "description": "The Crowd Compute question ID.", @@ -2100,12 +2100,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -2122,7 +2122,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", @@ -2167,7 +2167,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -2178,12 +2178,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -3016,6 +3016,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -3043,6 +3047,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement", @@ -4319,6 +4394,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -4346,6 +4425,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement", @@ -4813,7 +4963,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { - "description": "The long running operation metadata for batch process method.", + "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", "properties": { "createTime": { @@ -4867,7 +5017,7 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.", + "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument method.", "type": "string" }, "humanReviewStatus": { @@ -4890,7 +5040,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessRequest": { - "description": "Request message for batch process document method.", + "description": "Request message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessRequest", "properties": { "documentOutputConfig": { @@ -4932,7 +5082,7 @@ "type": "string" }, "mimeType": { - "description": "Mimetype of the input. If the input is a raw document, the supported mimetypes are application/pdf, image/tiff, and image/gif. If the input is a [Document] proto, the type should be application/json.", + "description": "Mimetype of the input. If the input is a raw document, the supported mimetypes are application/pdf, image/tiff, and image/gif. If the input is a Document proto, the type should be application/json.", "type": "string" } }, @@ -4950,7 +5100,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3BatchProcessResponse": { - "description": "Response message for batch process document method.", + "description": "Response message for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse", "properties": {}, "type": "object" @@ -5022,34 +5172,34 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { - "description": "The long running operation metadata for delete processor method.", + "description": "The long-running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": { - "description": "The long running operation metadata for delete processor version method.", + "description": "The long-running operation metadata for delete processor version method.", "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": { - "description": "The long running operation metadata for deploy processor version method.", + "description": "The long-running operation metadata for deploy processor version method.", "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -5067,12 +5217,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": { - "description": "The long running operation metadata for disable processor method.", + "description": "The long-running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -5905,6 +6055,10 @@ "provenance": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo", + "description": "Text style attributes." } }, "type": "object" @@ -5932,6 +6086,77 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the background." + }, + "bold": { + "description": "Whether the text is bold (equivalent to font weight \u003e= 700).", + "type": "boolean" + }, + "fontSize": { + "description": "Font size in points (1 point is 1/72\").", + "format": "int32", + "type": "integer" + }, + "fontType": { + "description": "Name or style of the font.", + "type": "string" + }, + "fontWeight": { + "description": "TrueType weight on a scale 100 (Thin) to 1000 (Ultra-heavy). Normal is 400, Bold is 700.", + "format": "int32", + "type": "integer" + }, + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" + }, + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", + "type": "number" + }, + "pixelFontSize": { + "description": "Font size in pixels, equal to unrounded_fontsize * resolution / 72.0.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text are small caps.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentPageVisualElement": { "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", "id": "GoogleCloudDocumentaiV1beta3DocumentPageVisualElement", @@ -6346,12 +6571,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { - "description": "The long running operation metadata for enable processor method.", + "description": "The long-running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -6374,7 +6599,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -6391,7 +6616,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { - "description": "Metadata of the EvaluateProcessorVersion method.", + "description": "Response of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", "properties": { "evaluation": { @@ -6680,7 +6905,7 @@ "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "state": { @@ -6694,10 +6919,10 @@ ], "enumDescriptions": [ "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review is not enabled on the processor or the processing request has been set to skip this document.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", "Human review validation is triggered and passed, so no review is needed.", "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the [state_message] for details." + "Some error happened during triggering human review, see the state_message for details." ], "type": "string" }, @@ -6709,18 +6934,18 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { - "description": "The long running operation metadata for the ImportProcessorVersion method.", + "description": "The long-running operation metadata for the ImportProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata for the long running operation." + "description": "The basic metadata for the long-running operation." } }, "type": "object" }, "GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest": { - "description": "The request message for the ImportProcessorVersion method. This method requires source processor version and destination processor are in the same location. This method requires Document AI Service Agent of the destination project in the source project's IAM with [Document AI Editor role](https://cloud.google.com/document-ai/docs/access-control/iam-roles). The destination project is specified as part of the `parent` field. The source project is specified as part of `source` field. The Service Agent for Document AI can be found in https://cloud.google.com/iam/docs/service-agents.", + "description": "The request message for the `ImportProcessorVersion` method. This method requires the source processor version and destination processor to be in the same location. This method requires the Document AI Service Agent of the destination project to have [Document AI Editor role](https://cloud.google.com/document-ai/docs/access-control/iam-roles) on the source project. The destination project is specified as part of the `parent` field. The source project is specified as part of `source` field. The Service Agent for Document AI can be found in https://cloud.google.com/iam/docs/service-agents.", "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest", "properties": { "processorVersionSource": { @@ -6742,7 +6967,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ListEvaluationsResponse": { - "description": "The response from ListEvaluations.", + "description": "The response from `ListEvaluations`.", "id": "GoogleCloudDocumentaiV1beta3ListEvaluationsResponse", "properties": { "evaluations": { @@ -6841,6 +7066,10 @@ }, "type": "array" }, + "computeStyleInfo": { + "description": "Turn on font id model and returns font style information.", + "type": "boolean" + }, "enableImageQualityScores": { "description": "Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call.", "type": "boolean" @@ -6894,7 +7123,7 @@ "description": "The document payload, the [content] and [mime_type] fields must be set." }, "fieldMask": { - "description": "Specifies which fields to include in ProcessResponse's document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", + "description": "Specifies which fields to include in the `ProcessResponse` Document. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", "format": "google-fieldmask", "type": "string" }, @@ -6926,7 +7155,7 @@ "description": "The document payload, will populate fields based on the processor's behavior." }, "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.", + "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field is empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", "type": "string" }, "humanReviewStatus": { @@ -6993,7 +7222,7 @@ "type": "string" }, "type": { - "description": "The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc. To get a list of processors types, see FetchProcessorTypes.", + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", "type": "string" } }, @@ -7054,7 +7283,7 @@ "type": "array" }, "type": { - "description": "The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, etc.", + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.", "type": "string" } }, @@ -7174,12 +7403,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": { - "description": "The long running operation metadata for review document method.", + "description": "The long-running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "createTime": { "description": "The creation time of the operation.", @@ -7287,12 +7516,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long running operation metadata for set default processor version method.", + "description": "The long-running operation metadata for set default processor version method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7320,7 +7549,7 @@ "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." }, "testDatasetValidation": { "$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation", @@ -7403,7 +7632,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse": { - "description": "The response for the TrainProcessorVersion method.", + "description": "The response for TrainProcessorVersion.", "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse", "properties": { "processorVersion": { @@ -7414,12 +7643,12 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata": { - "description": "The long running operation metadata for the undeploy processor version method.", + "description": "The long-running operation metadata for the undeploy processor version method.", "id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long running operation." + "description": "The basic metadata of the long-running operation." } }, "type": "object" @@ -7472,7 +7701,7 @@ "type": "object" }, "GoogleCloudLocationLocation": { - "description": "A resource that represents Google Cloud Platform location.", + "description": "A resource that represents a Google Cloud location.", "id": "GoogleCloudLocationLocation", "properties": { "displayName": { diff --git a/documentai/v1beta3/documentai-gen.go b/documentai/v1beta3/documentai-gen.go index 6ae33876176..039fdb0cb66 100644 --- a/documentai/v1beta3/documentai-gen.go +++ b/documentai/v1beta3/documentai-gen.go @@ -525,9 +525,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata) MarshalJSON() ([ } // GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: The -// long running operation metadata for CreateLabelerPool. +// long-running operation metadata for CreateLabelerPool. type GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -555,9 +555,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata) Marsh } // GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: The -// long running operation metadata for DeleteLabelerPool. +// long-running operation metadata for DeleteLabelerPool. type GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -584,10 +584,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata) Marsh return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The long -// running operation metadata for delete processor method. +// GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: The +// long-running operation metadata for delete processor method. type GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -615,9 +615,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata) MarshalJSON() ([ } // GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: The -// long running operation metadata for delete processor version method. +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -645,9 +645,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata) MarshalJS } // GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: The -// long running operation metadata for deploy processor version method. +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -679,10 +679,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata) MarshalJS type GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The long -// running operation metadata for disable processor method. +// GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: The +// long-running operation metadata for disable processor method. type GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -780,10 +780,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId) MarshalJS return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The long -// running operation metadata for enable processor method. +// GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: The +// long-running operation metadata for enable processor method. type GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -819,7 +819,7 @@ type GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse struct { // GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: // Metadata of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -847,7 +847,7 @@ func (s *GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata) Marshal } // GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: -// Metadata of the EvaluateProcessorVersion method. +// Response of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` @@ -1176,10 +1176,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse struct { } // GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: The -// long running operation metadata for the ImportProcessorVersion +// long-running operation metadata for the ImportProcessorVersion // method. type GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long running operation. + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1418,10 +1418,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3RevisionRef) MarshalJSON() ([]byte, error } // GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: The -// long running operation metadata for set default processor version +// long-running operation metadata for set default processor version // method. type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1456,7 +1456,7 @@ type GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: The // metadata that represents a processor version being created. type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -1535,7 +1535,7 @@ func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValid } // GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: The -// response for the TrainProcessorVersion method. +// response for TrainProcessorVersion. type GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -1566,10 +1566,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse) MarshalJSO } // GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: The -// long running operation metadata for the undeploy processor version +// long-running operation metadata for the undeploy processor version // method. type GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1630,10 +1630,10 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata) MarshalJS } // GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: The -// long running operation metadata for updating the human review +// long-running operation metadata for updating the human review // configuration. type GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1661,9 +1661,9 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata) MarshalJ } // GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: The -// long running operation metadata for UpdateLabelerPool. +// long-running operation metadata for UpdateLabelerPool. type GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1690,8 +1690,8 @@ func (s *GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata) Marsh return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1BatchProcessMetadata: The long running -// operation metadata for batch process method. +// GoogleCloudDocumentaiV1BatchProcessMetadata: The long-running +// operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,omitempty"` @@ -1791,7 +1791,7 @@ func (s *GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus) Mar } // GoogleCloudDocumentaiV1BatchProcessResponse: Response message for -// batch process document method. +// BatchProcessDocuments. type GoogleCloudDocumentaiV1BatchProcessResponse struct { } @@ -1845,10 +1845,10 @@ func (s *GoogleCloudDocumentaiV1CommonOperationMetadata) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long running +// GoogleCloudDocumentaiV1DeleteProcessorMetadata: The long-running // operation metadata for delete processor method. type GoogleCloudDocumentaiV1DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1875,10 +1875,10 @@ func (s *GoogleCloudDocumentaiV1DeleteProcessorMetadata) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The long -// running operation metadata for delete processor version method. +// GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: The +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1905,10 +1905,10 @@ func (s *GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The long -// running operation metadata for deploy processor version method. +// GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: The +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiV1DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1940,10 +1940,10 @@ func (s *GoogleCloudDocumentaiV1DeployProcessorVersionMetadata) MarshalJSON() ([ type GoogleCloudDocumentaiV1DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiV1DisableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1DisableProcessorMetadata: The long-running // operation metadata for disable processor method. type GoogleCloudDocumentaiV1DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -1976,10 +1976,10 @@ func (s *GoogleCloudDocumentaiV1DisableProcessorMetadata) MarshalJSON() ([]byte, type GoogleCloudDocumentaiV1DisableProcessorResponse struct { } -// GoogleCloudDocumentaiV1EnableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1EnableProcessorMetadata: The long-running // operation metadata for enable processor method. type GoogleCloudDocumentaiV1EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2015,7 +2015,7 @@ type GoogleCloudDocumentaiV1EnableProcessorResponse struct { // GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: Metadata of // the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2042,7 +2042,7 @@ func (s *GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata) MarshalJSON() return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Metadata of +// GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: Response of // the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. @@ -2075,10 +2075,9 @@ func (s *GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse) MarshalJSON() // on a processed document. type GoogleCloudDocumentaiV1HumanReviewStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. This field is populated only when the [state] is - // [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and - // metadata as the long running operation returned by [ReviewDocument] - // method. + // processed document. This field is populated only when the state is + // `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + // metadata as the long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // State: The state of human review on the processing request. @@ -2087,14 +2086,14 @@ type GoogleCloudDocumentaiV1HumanReviewStatus struct { // "STATE_UNSPECIFIED" - Human review state is unspecified. Most // likely due to an internal error. // "SKIPPED" - Human review is skipped for the document. This can - // happen because human review is not enabled on the processor or the + // happen because human review isn't enabled on the processor or the // processing request has been set to skip this document. // "VALIDATION_PASSED" - Human review validation is triggered and // passed, so no review is needed. // "IN_PROGRESS" - Human review validation is triggered and the // document is under review. // "ERROR" - Some error happened during triggering human review, see - // the [state_message] for details. + // the state_message for details. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review @@ -2126,10 +2125,10 @@ func (s *GoogleCloudDocumentaiV1HumanReviewStatus) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The long -// running operation metadata for review document method. +// GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: The +// long-running operation metadata for review document method. type GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // QuestionId: The Crowd Compute question ID. @@ -2202,10 +2201,11 @@ func (s *GoogleCloudDocumentaiV1ReviewDocumentResponse) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The long -// running operation metadata for set default processor version method. +// GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: The +// long-running operation metadata for set default processor version +// method. type GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -2240,7 +2240,7 @@ type GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: The metadata // that represents a processor version being created. type GoogleCloudDocumentaiV1TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -2321,7 +2321,7 @@ func (s *GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation) } // GoogleCloudDocumentaiV1TrainProcessorVersionResponse: The response -// for the TrainProcessorVersion method. +// for TrainProcessorVersion. type GoogleCloudDocumentaiV1TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -2351,10 +2351,11 @@ func (s *GoogleCloudDocumentaiV1TrainProcessorVersionResponse) MarshalJSON() ([] return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The long -// running operation metadata for the undeploy processor version method. +// GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: The +// long-running operation metadata for the undeploy processor version +// method. type GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -3668,6 +3669,9 @@ type GoogleCloudDocumentaiV1beta1DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta1DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -3727,6 +3731,96 @@ func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta1DocumentPageVisualElement struct { @@ -5840,6 +5934,9 @@ type GoogleCloudDocumentaiV1beta2DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta2DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -5899,6 +5996,96 @@ func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta2DocumentPageVisualElement struct { @@ -6760,8 +6947,8 @@ func (s *GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long running -// operation metadata for batch process method. +// GoogleCloudDocumentaiV1beta3BatchProcessMetadata: The long-running +// operation metadata for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessMetadata struct { // CreateTime: The creation time of the operation. CreateTime string `json:"createTime,omitempty"` @@ -6818,9 +7005,9 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadata) MarshalJSON() ([]byte // s: The status of a each individual document in the batch process. type GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. If the human review process is not triggered, - // this field will be empty. It has the same response type and metadata - // as the long running operation returned by ReviewDocument method. + // processed document. If the human review process isn't triggered, this + // field will be empty. It has the same response type and metadata as + // the long-running operation returned by ReviewDocument method. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // HumanReviewStatus: The status of human review on the processed @@ -6868,7 +7055,7 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus } // GoogleCloudDocumentaiV1beta3BatchProcessRequest: Request message for -// batch process document method. +// BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessRequest struct { // DocumentOutputConfig: The overall output config for batch process. DocumentOutputConfig *GoogleCloudDocumentaiV1beta3DocumentOutputConfig `json:"documentOutputConfig,omitempty"` @@ -6923,7 +7110,7 @@ type GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig struct { // MimeType: Mimetype of the input. If the input is a raw document, the // supported mimetypes are application/pdf, image/tiff, and image/gif. - // If the input is a [Document] proto, the type should be + // If the input is a Document proto, the type should be // application/json. MimeType string `json:"mimeType,omitempty"` @@ -6982,7 +7169,7 @@ func (s *GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig) Marsh } // GoogleCloudDocumentaiV1beta3BatchProcessResponse: Response message -// for batch process document method. +// for BatchProcessDocuments. type GoogleCloudDocumentaiV1beta3BatchProcessResponse struct { } @@ -7069,10 +7256,10 @@ func (s *GoogleCloudDocumentaiV1beta3CommonOperationMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long running +// GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: The long-running // operation metadata for delete processor method. type GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7099,10 +7286,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The long -// running operation metadata for delete processor version method. +// GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: The +// long-running operation metadata for delete processor version method. type GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7129,10 +7316,10 @@ func (s *GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The long -// running operation metadata for deploy processor version method. +// GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: The +// long-running operation metadata for deploy processor version method. type GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -7169,10 +7356,10 @@ type GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest struct { type GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse struct { } -// GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The long -// running operation metadata for disable processor method. +// GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: The +// long-running operation metadata for disable processor method. type GoogleCloudDocumentaiV1beta3DisableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -8483,6 +8670,9 @@ type GoogleCloudDocumentaiV1beta3DocumentPageToken struct { // Provenance: The history of this annotation. Provenance *GoogleCloudDocumentaiV1beta3DocumentProvenance `json:"provenance,omitempty"` + // StyleInfo: Text style attributes. + StyleInfo *GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo `json:"styleInfo,omitempty"` + // ForceSendFields is a list of field names (e.g. "DetectedBreak") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -8542,6 +8732,96 @@ func (s *GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak) MarshalJSON return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo: Font and +// other text style attributes. +type GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo struct { + // BackgroundColor: Color of the background. + BackgroundColor *GoogleTypeColor `json:"backgroundColor,omitempty"` + + // Bold: Whether the text is bold (equivalent to font weight >= 700). + Bold bool `json:"bold,omitempty"` + + // FontSize: Font size in points (1 point is 1/72"). + FontSize int64 `json:"fontSize,omitempty"` + + // FontType: Name or style of the font. + FontType string `json:"fontType,omitempty"` + + // FontWeight: TrueType weight on a scale 100 (Thin) to 1000 + // (Ultra-heavy). Normal is 400, Bold is 700. + FontWeight int64 `json:"fontWeight,omitempty"` + + // Handwritten: Whether the text is handwritten. + Handwritten bool `json:"handwritten,omitempty"` + + // Italic: Whether the text is italic. + Italic bool `json:"italic,omitempty"` + + // LetterSpacing: Letter spacing in points. + LetterSpacing float64 `json:"letterSpacing,omitempty"` + + // PixelFontSize: Font size in pixels, equal to unrounded_fontsize * + // resolution / 72.0. + PixelFontSize float64 `json:"pixelFontSize,omitempty"` + + // Smallcaps: Whether the text are small caps. + Smallcaps bool `json:"smallcaps,omitempty"` + + // Strikeout: Whether the text is strikethrough. + Strikeout bool `json:"strikeout,omitempty"` + + // Subscript: Whether the text is a subscript. + Subscript bool `json:"subscript,omitempty"` + + // Superscript: Whether the text is a superscript. + Superscript bool `json:"superscript,omitempty"` + + // TextColor: Color of the text. + TextColor *GoogleTypeColor `json:"textColor,omitempty"` + + // Underlined: Whether the text is underlined. + Underlined bool `json:"underlined,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BackgroundColor") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BackgroundColor") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo + var s1 struct { + LetterSpacing gensupport.JSONFloat64 `json:"letterSpacing"` + PixelFontSize gensupport.JSONFloat64 `json:"pixelFontSize"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.LetterSpacing = float64(s1.LetterSpacing) + s.PixelFontSize = float64(s1.PixelFontSize) + return nil +} + // GoogleCloudDocumentaiV1beta3DocumentPageVisualElement: Detected // non-text visual elements e.g. checkbox, signature etc. on the page. type GoogleCloudDocumentaiV1beta3DocumentPageVisualElement struct { @@ -9233,10 +9513,10 @@ func (s *GoogleCloudDocumentaiV1beta3DocumentTextChange) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long running +// GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: The long-running // operation metadata for enable processor method. type GoogleCloudDocumentaiV1beta3EnableProcessorMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -9277,7 +9557,7 @@ type GoogleCloudDocumentaiV1beta3EnableProcessorResponse struct { // GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: // Metadata of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -9336,7 +9616,7 @@ func (s *GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest) MarshalJSO } // GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: -// Metadata of the EvaluateProcessorVersion method. +// Response of the EvaluateProcessorVersion method. type GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse struct { // Evaluation: The resource name of the created evaluation. Evaluation string `json:"evaluation,omitempty"` @@ -9845,10 +10125,9 @@ func (s *GoogleCloudDocumentaiV1beta3GcsPrefix) MarshalJSON() ([]byte, error) { // review on a processed document. type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { // HumanReviewOperation: The name of the operation triggered by the - // processed document. This field is populated only when the [state] is - // [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and - // metadata as the long running operation returned by [ReviewDocument] - // method. + // processed document. This field is populated only when the state is + // `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + // metadata as the long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // State: The state of human review on the processing request. @@ -9857,14 +10136,14 @@ type GoogleCloudDocumentaiV1beta3HumanReviewStatus struct { // "STATE_UNSPECIFIED" - Human review state is unspecified. Most // likely due to an internal error. // "SKIPPED" - Human review is skipped for the document. This can - // happen because human review is not enabled on the processor or the + // happen because human review isn't enabled on the processor or the // processing request has been set to skip this document. // "VALIDATION_PASSED" - Human review validation is triggered and // passed, so no review is needed. // "IN_PROGRESS" - Human review validation is triggered and the // document is under review. // "ERROR" - Some error happened during triggering human review, see - // the [state_message] for details. + // the state_message for details. State string `json:"state,omitempty"` // StateMessage: A message providing more details about the human review @@ -9896,10 +10175,11 @@ func (s *GoogleCloudDocumentaiV1beta3HumanReviewStatus) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The long -// running operation metadata for the ImportProcessorVersion method. +// GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: The +// long-running operation metadata for the ImportProcessorVersion +// method. type GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata for the long running operation. + // CommonMetadata: The basic metadata for the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -9927,15 +10207,14 @@ func (s *GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata) MarshalJSON } // GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest: The -// request message for the ImportProcessorVersion method. This method -// requires source processor version and destination processor are in -// the same location. This method requires Document AI Service Agent of -// the destination project in the source project's IAM with Document AI -// Editor role -// (https://cloud.google.com/document-ai/docs/access-control/iam-roles). -// The destination project is specified as part of the `parent` field. -// The source project is specified as part of `source` field. The -// Service Agent for Document AI can be found in +// request message for the `ImportProcessorVersion` method. This method +// requires the source processor version and destination processor to be +// in the same location. This method requires the Document AI Service +// Agent of the destination project to have Document AI Editor role +// (https://cloud.google.com/document-ai/docs/access-control/iam-roles) +// on the source project. The destination project is specified as part +// of the `parent` field. The source project is specified as part of +// `source` field. The Service Agent for Document AI can be found in // https://cloud.google.com/iam/docs/service-agents. type GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest struct { // ProcessorVersionSource: The source processor version to import from. @@ -9997,7 +10276,7 @@ func (s *GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse) MarshalJSON } // GoogleCloudDocumentaiV1beta3ListEvaluationsResponse: The response -// from ListEvaluations. +// from `ListEvaluations`. type GoogleCloudDocumentaiV1beta3ListEvaluationsResponse struct { // Evaluations: The evaluations requested. Evaluations []*GoogleCloudDocumentaiV1beta3Evaluation `json:"evaluations,omitempty"` @@ -10201,6 +10480,10 @@ type GoogleCloudDocumentaiV1beta3OcrConfig struct { // their situation. AdvancedOcrOptions []string `json:"advancedOcrOptions,omitempty"` + // ComputeStyleInfo: Turn on font id model and returns font style + // information. + ComputeStyleInfo bool `json:"computeStyleInfo,omitempty"` + // EnableImageQualityScores: Enables intelligent document quality scores // after OCR. Can help with diagnosing why OCR responses are of poor // quality for a given input. Adds additional latency comparable to @@ -10312,8 +10595,8 @@ type GoogleCloudDocumentaiV1beta3ProcessRequest struct { // must be set. Document *GoogleCloudDocumentaiV1beta3Document `json:"document,omitempty"` - // FieldMask: Specifies which fields to include in ProcessResponse's - // document. Only supports top level document and pages field so it must + // FieldMask: Specifies which fields to include in the `ProcessResponse` + // Document. Only supports top level document and pages field so it must // be in the form of `{document_field_name}` or // `pages.{page_field_name}`. FieldMask string `json:"fieldMask,omitempty"` @@ -10362,9 +10645,9 @@ type GoogleCloudDocumentaiV1beta3ProcessResponse struct { Document *GoogleCloudDocumentaiV1beta3Document `json:"document,omitempty"` // HumanReviewOperation: The name of the operation triggered by the - // processed document. If the human review process is not triggered, - // this field will be empty. It has the same response type and metadata - // as the long running operation returned by ReviewDocument method. + // processed document. If the human review process isn't triggered, this + // field is empty. It has the same response type and metadata as the + // long-running operation returned by ReviewDocument. HumanReviewOperation string `json:"humanReviewOperation,omitempty"` // HumanReviewStatus: The status of human review on the processed @@ -10449,8 +10732,9 @@ type GoogleCloudDocumentaiV1beta3Processor struct { // successful. State string `json:"state,omitempty"` - // Type: The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, - // etc. To get a list of processors types, see FetchProcessorTypes. + // Type: The processor type, such as: `OCR_PROCESSOR`, + // `INVOICE_PROCESSOR`. To get a list of processor types, see + // FetchProcessorTypes. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -10542,8 +10826,8 @@ type GoogleCloudDocumentaiV1beta3ProcessorType struct { // for this processor. SampleDocumentUris []string `json:"sampleDocumentUris,omitempty"` - // Type: The processor type, e.g., `OCR_PROCESSOR`, `INVOICE_PROCESSOR`, - // etc. + // Type: The processor type, such as: `OCR_PROCESSOR`, + // `INVOICE_PROCESSOR`. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -10755,10 +11039,10 @@ func (s *GoogleCloudDocumentaiV1beta3RawDocument) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The long -// running operation metadata for review document method. +// GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: The +// long-running operation metadata for review document method. type GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // CreateTime: The creation time of the operation. @@ -10902,10 +11186,10 @@ func (s *GoogleCloudDocumentaiV1beta3ReviewDocumentResponse) MarshalJSON() ([]by } // GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: The -// long running operation metadata for set default processor version +// long-running operation metadata for set default processor version // method. type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -10974,7 +11258,7 @@ type GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse struct { // GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: The // metadata that represents a processor version being created. type GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // TestDatasetValidation: The test dataset validation information. @@ -11131,7 +11415,7 @@ func (s *GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData) Mars } // GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: The -// response for the TrainProcessorVersion method. +// response for TrainProcessorVersion. type GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse struct { // ProcessorVersion: The resource name of the processor version produced // by training. @@ -11162,10 +11446,10 @@ func (s *GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse) MarshalJSON( } // GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: The -// long running operation metadata for the undeploy processor version +// long-running operation metadata for the undeploy processor version // method. type GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata struct { - // CommonMetadata: The basic metadata of the long running operation. + // CommonMetadata: The basic metadata of the long-running operation. CommonMetadata *GoogleCloudDocumentaiV1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "CommonMetadata") to @@ -11272,8 +11556,8 @@ func (s *GoogleCloudLocationListLocationsResponse) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudLocationLocation: A resource that represents Google Cloud -// Platform location. +// GoogleCloudLocationLocation: A resource that represents a Google +// Cloud location. type GoogleCloudLocationLocation struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo". @@ -11930,8 +12214,8 @@ type ProjectsLocationsFetchProcessorTypesCall struct { header_ http.Header } -// FetchProcessorTypes: Fetches processor types. Note that we do not use -// ListProcessorTypes here because it is not paginated. +// FetchProcessorTypes: Fetches processor types. Note that we don't use +// ListProcessorTypes here, because it isn't paginated. // // - parent: The project of processor type to list. The available // processor types may depend on the allow-listing on projects. @@ -12044,7 +12328,7 @@ func (c *ProjectsLocationsFetchProcessorTypesCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.", + // "description": "Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.", // "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes", // "httpMethod": "GET", // "id": "documentai.projects.locations.fetchProcessorTypes", @@ -16438,8 +16722,9 @@ func (r *ProjectsLocationsProcessorsProcessorVersionsEvaluationsService) List(pa } // PageSize sets the optional parameter "pageSize": The standard list -// page size. If unspecified, at most 5 evaluations will be returned. -// The maximum value is 100; values above 100 will be coerced to 100. +// page size. If unspecified, at most `5` evaluations will be returned. +// The maximum value is `100`; values above `100` will be coerced to +// `100`. func (c *ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall) PageSize(pageSize int64) *ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -16563,7 +16848,7 @@ func (c *ProjectsLocationsProcessorsProcessorVersionsEvaluationsListCall) Do(opt // ], // "parameters": { // "pageSize": { - // "description": "The standard list page size. If unspecified, at most 5 evaluations will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + // "description": "The standard list page size. If unspecified, at most `5` evaluations will be returned. The maximum value is `100`; values above `100` will be coerced to `100`.", // "format": "int32", // "location": "query", // "type": "integer" diff --git a/fcm/v1/fcm-api.json b/fcm/v1/fcm-api.json index a9730e63812..a45545e7b60 100644 --- a/fcm/v1/fcm-api.json +++ b/fcm/v1/fcm-api.json @@ -146,7 +146,7 @@ } } }, - "revision": "20221115", + "revision": "20230421", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { @@ -304,6 +304,22 @@ ], "type": "string" }, + "proxy": { + "description": "Setting to control when a notification may be proxied.", + "enum": [ + "PROXY_UNSPECIFIED", + "ALLOW", + "DENY", + "IF_PRIORITY_LOWERED" + ], + "enumDescriptions": [ + "If unspecified, default to `Proxy.IF_PRIORITY_LOWERED`.", + "Try to proxy this notification.", + "Do not proxy this notification.", + "Only try to proxy this notification if its `AndroidMessagePriority` was lowered from `HIGH` to `NORMAL` on the device." + ], + "type": "string" + }, "sound": { "description": "The sound to play when the device receives the notification. Supports \"default\" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.", "type": "string" diff --git a/fcm/v1/fcm-gen.go b/fcm/v1/fcm-gen.go index 32b2d094faf..2bb5b18d002 100644 --- a/fcm/v1/fcm-gen.go +++ b/fcm/v1/fcm-gen.go @@ -421,6 +421,18 @@ type AndroidNotification struct { // attention or input. NotificationPriority string `json:"notificationPriority,omitempty"` + // Proxy: Setting to control when a notification may be proxied. + // + // Possible values: + // "PROXY_UNSPECIFIED" - If unspecified, default to + // `Proxy.IF_PRIORITY_LOWERED`. + // "ALLOW" - Try to proxy this notification. + // "DENY" - Do not proxy this notification. + // "IF_PRIORITY_LOWERED" - Only try to proxy this notification if its + // `AndroidMessagePriority` was lowered from `HIGH` to `NORMAL` on the + // device. + Proxy string `json:"proxy,omitempty"` + // Sound: The sound to play when the device receives the notification. // Supports "default" or the filename of a sound resource bundled in the // app. Sound files must reside in /res/raw/. diff --git a/healthcare/v1/healthcare-api.json b/healthcare/v1/healthcare-api.json index 2518ec6ffed..5515563611d 100644 --- a/healthcare/v1/healthcare-api.json +++ b/healthcare/v1/healthcare-api.json @@ -4078,7 +4078,7 @@ } } }, - "revision": "20230321", + "revision": "20230412", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5107,6 +5107,25 @@ }, "type": "object" }, + "FhirNotificationConfig": { + "description": "Contains the configuration for FHIR notifications.", + "id": "FhirNotificationConfig", + "properties": { + "pubsubTopic": { + "description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).", + "type": "string" + }, + "sendFullResource": { + "description": "Whether to send full FHIR resource to this Pub/Sub topic.", + "type": "boolean" + }, + "sendPreviousResourceOnDelete": { + "description": "Whether to send full FHIR resource to this pubsub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "type": "boolean" + } + }, + "type": "object" + }, "FhirStore": { "description": "Represents a FHIR store.", "id": "FhirStore", @@ -5154,7 +5173,14 @@ }, "notificationConfig": { "$ref": "NotificationConfig", - "description": "If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"." + "description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"." + }, + "notificationConfigs": { + "description": "Specifies where and whether to send notifications upon changes to a FHIR store.", + "items": { + "$ref": "FhirNotificationConfig" + }, + "type": "array" }, "streamConfigs": { "description": "A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.", diff --git a/healthcare/v1/healthcare-gen.go b/healthcare/v1/healthcare-gen.go index f409b170886..0ba7dd53bc3 100644 --- a/healthcare/v1/healthcare-gen.go +++ b/healthcare/v1/healthcare-gen.go @@ -2388,6 +2388,67 @@ func (s *FhirFilter) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// FhirNotificationConfig: Contains the configuration for FHIR +// notifications. +type FhirNotificationConfig struct { + // PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/) + // topic that notifications of changes are published on. Supplied by the + // client. The notification is a `PubsubMessage` with the following + // fields: * `PubsubMessage.Data` contains the resource name. * + // `PubsubMessage.MessageId` is the ID of this notification. It is + // guaranteed to be unique within the topic. * + // `PubsubMessage.PublishTime` is the time when the message was + // published. Note that notifications are only sent if the topic is + // non-empty. Topic names + // (https://cloud.google.com/pubsub/docs/overview#names) must be scoped + // to a project. The Cloud Healthcare API service account, + // service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have + // publisher permissions on the given Pub/Sub topic. Not having adequate + // permissions causes the calls that send notifications to fail + // (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). + // If a notification can't be published to Pub/Sub, errors are logged to + // Cloud Logging. For more information, see Viewing error logs in Cloud + // Logging + // (https://cloud.google.com/healthcare-api/docs/how-tos/logging). + PubsubTopic string `json:"pubsubTopic,omitempty"` + + // SendFullResource: Whether to send full FHIR resource to this Pub/Sub + // topic. + SendFullResource bool `json:"sendFullResource,omitempty"` + + // SendPreviousResourceOnDelete: Whether to send full FHIR resource to + // this pubsub topic for deleting FHIR resource. Note that setting this + // to true does not guarantee that all previous resources will be sent + // in the format of full FHIR resource. When a resource change is too + // large or during heavy traffic, only the resource name will be sent. + // Clients should always check the "payloadType" label from a Pub/Sub + // message to determine whether it needs to fetch the full previous + // resource as a separate operation. + SendPreviousResourceOnDelete bool `json:"sendPreviousResourceOnDelete,omitempty"` + + // ForceSendFields is a list of field names (e.g. "PubsubTopic") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "PubsubTopic") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *FhirNotificationConfig) MarshalJSON() ([]byte, error) { + type NoMethod FhirNotificationConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // FhirStore: Represents a FHIR store. type FhirStore struct { // ComplexDataTypeReferenceParsing: Enable parsing of references within @@ -2467,12 +2528,17 @@ type FhirStore struct { // }`. Name string `json:"name,omitempty"` - // NotificationConfig: If non-empty, publish all resource modifications - // of this FHIR store to this destination. The Pub/Sub message - // attributes contain a map with a string describing the action that has - // triggered the notification. For example, "action":"CreateResource". + // NotificationConfig: Deprecated. Use `notification_configs` instead. + // If non-empty, publish all resource modifications of this FHIR store + // to this destination. The Pub/Sub message attributes contain a map + // with a string describing the action that has triggered the + // notification. For example, "action":"CreateResource". NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"` + // NotificationConfigs: Specifies where and whether to send + // notifications upon changes to a FHIR store. + NotificationConfigs []*FhirNotificationConfig `json:"notificationConfigs,omitempty"` + // StreamConfigs: A list of streaming configs that configure the // destinations of streaming export for every resource mutation in this // FHIR store. Each store is allowed to have up to 10 streaming configs. diff --git a/healthcare/v1beta1/healthcare-api.json b/healthcare/v1beta1/healthcare-api.json index bc388699639..19b4cfd1f22 100644 --- a/healthcare/v1beta1/healthcare-api.json +++ b/healthcare/v1beta1/healthcare-api.json @@ -3655,7 +3655,7 @@ ] }, "Resource-incoming-references": { - "description": "Gets all incoming references to a given target FHIR resource. Can also get all incoming references when the target resource does not exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.", + "description": "Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$references", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-incoming-references", @@ -4941,7 +4941,7 @@ } } }, - "revision": "20230321", + "revision": "20230412", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "Action": { @@ -6388,6 +6388,10 @@ "sendFullResource": { "description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", "type": "boolean" + }, + "sendPreviousResourceOnDelete": { + "description": "Whether to send full FHIR resource to this pubsub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "type": "boolean" } }, "type": "object" @@ -6450,7 +6454,7 @@ }, "notificationConfig": { "$ref": "NotificationConfig", - "description": "If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\". Deprecated. Use `notification_configs` instead." + "description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"." }, "notificationConfigs": { "description": "Specifies where and whether to send notifications upon changes to a Fhir store.", diff --git a/healthcare/v1beta1/healthcare-gen.go b/healthcare/v1beta1/healthcare-gen.go index 34afa81b041..ac48f3015b3 100644 --- a/healthcare/v1beta1/healthcare-gen.go +++ b/healthcare/v1beta1/healthcare-gen.go @@ -3170,6 +3170,16 @@ type FhirNotificationConfig struct { // operation. SendFullResource bool `json:"sendFullResource,omitempty"` + // SendPreviousResourceOnDelete: Whether to send full FHIR resource to + // this pubsub topic for deleting FHIR resource. Note that setting this + // to true does not guarantee that all previous resources will be sent + // in the format of full FHIR resource. When a resource change is too + // large or during heavy traffic, only the resource name will be sent. + // Clients should always check the "payloadType" label from a Pub/Sub + // message to determine whether it needs to fetch the full previous + // resource as a separate operation. + SendPreviousResourceOnDelete bool `json:"sendPreviousResourceOnDelete,omitempty"` + // ForceSendFields is a list of field names (e.g. "PubsubTopic") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -3309,11 +3319,11 @@ type FhirStore struct { // }`. Name string `json:"name,omitempty"` - // NotificationConfig: If non-empty, publish all resource modifications - // of this FHIR store to this destination. The Pub/Sub message - // attributes contain a map with a string describing the action that has - // triggered the notification. For example, "action":"CreateResource". - // Deprecated. Use `notification_configs` instead. + // NotificationConfig: Deprecated. Use `notification_configs` instead. + // If non-empty, publish all resource modifications of this FHIR store + // to this destination. The Pub/Sub message attributes contain a map + // with a string describing the action that has triggered the + // notification. For example, "action":"CreateResource". NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"` // NotificationConfigs: Specifies where and whether to send @@ -25471,15 +25481,15 @@ type ProjectsLocationsDatasetsFhirStoresFhirResourceIncomingReferencesCall struc header_ http.Header } -// ResourceIncomingReferences: Gets all incoming references to a given -// target FHIR resource. Can also get all incoming references when the -// target resource does not exist, for example, if the target has been -// deleted. On success, the response body contains a Bundle with type -// `searchset`, where each entry in the Bundle contains the full content -// of the resource. If the operation fails, an `OperationOutcome` is -// returned describing the failure. If the request cannot be mapped to a -// valid API method on a FHIR store, a generic Google Cloud error might -// be returned instead. +// ResourceIncomingReferences: Lists all the resources that directly +// refer to the given target FHIR resource. Can also support the case +// when the target resource doesn't exist, for example, if the target +// has been deleted. On success, the response body contains a Bundle +// with type `searchset`, where each entry in the Bundle contains the +// full content of the resource. If the operation fails, an +// `OperationOutcome` is returned describing the failure. If the request +// cannot be mapped to a valid API method on a FHIR store, a generic +// Google Cloud error might be returned instead. // // - parent: The name of the FHIR store that holds the target resource. func (r *ProjectsLocationsDatasetsFhirStoresFhirService) ResourceIncomingReferences(parent string) *ProjectsLocationsDatasetsFhirStoresFhirResourceIncomingReferencesCall { @@ -25602,7 +25612,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirResourceIncomingReferencesCall) gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Gets all incoming references to a given target FHIR resource. Can also get all incoming references when the target resource does not exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.", + // "description": "Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$references", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-incoming-references", diff --git a/language/v1/language-api.json b/language/v1/language-api.json index 9a7b6ff3027..b796575a1df 100644 --- a/language/v1/language-api.json +++ b/language/v1/language-api.json @@ -227,7 +227,7 @@ } } }, - "revision": "20221015", + "revision": "20230424", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -505,7 +505,7 @@ "type": "number" }, "name": { - "description": "The name of the category representing the document, from the [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).", + "description": "The name of the category representing the document.", "type": "string" } }, diff --git a/language/v1/language-gen.go b/language/v1/language-gen.go index 0ace51602de..b2b76ec2068 100644 --- a/language/v1/language-gen.go +++ b/language/v1/language-gen.go @@ -612,9 +612,7 @@ type ClassificationCategory struct { // represents the given text. Confidence float64 `json:"confidence,omitempty"` - // Name: The name of the category representing the document, from the - // predefined taxonomy - // (https://cloud.google.com/natural-language/docs/categories). + // Name: The name of the category representing the document. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json index 39f679e0877..9aca9de4814 100644 --- a/language/v1beta2/language-api.json +++ b/language/v1beta2/language-api.json @@ -227,7 +227,7 @@ } } }, - "revision": "20221015", + "revision": "20230424", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -505,7 +505,7 @@ "type": "number" }, "name": { - "description": "The name of the category representing the document, from the [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).", + "description": "The name of the category representing the document.", "type": "string" } }, @@ -890,7 +890,7 @@ "type": "object" }, "Features": { - "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 11", + "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 12", "id": "Features", "properties": { "classificationModelOptions": { diff --git a/language/v1beta2/language-gen.go b/language/v1beta2/language-gen.go index a79a058c200..f45f4c0bafa 100644 --- a/language/v1beta2/language-gen.go +++ b/language/v1beta2/language-gen.go @@ -612,9 +612,7 @@ type ClassificationCategory struct { // represents the given text. Confidence float64 `json:"confidence,omitempty"` - // Name: The name of the category representing the document, from the - // predefined taxonomy - // (https://cloud.google.com/natural-language/docs/categories). + // Name: The name of the category representing the document. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to @@ -1100,7 +1098,7 @@ func (s *EntityMention) MarshalJSON() ([]byte, error) { // Features: All available features for sentiment, syntax, and semantic // analysis. Setting each one to true will enable that specific analysis -// for the input. Next ID: 11 +// for the input. Next ID: 12 type Features struct { // ClassificationModelOptions: The model options to use for // classification. Defaults to v1 options if not specified. Only used if diff --git a/redis/v1/redis-api.json b/redis/v1/redis-api.json index 5b49e01fe3b..cc6bcb9e471 100644 --- a/redis/v1/redis-api.json +++ b/redis/v1/redis-api.json @@ -624,7 +624,7 @@ } } }, - "revision": "20230318", + "revision": "20230418", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { @@ -1092,7 +1092,7 @@ "type": "object" }, "Location": { - "description": "A resource that represents Google Cloud Platform location.", + "description": "A resource that represents Google Cloud location.", "id": "Location", "properties": { "displayName": { diff --git a/redis/v1/redis-gen.go b/redis/v1/redis-gen.go index eabf7f4b2b9..d33779b9139 100644 --- a/redis/v1/redis-gen.go +++ b/redis/v1/redis-gen.go @@ -882,7 +882,7 @@ func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Location: A resource that represents Google Cloud Platform location. +// Location: A resource that represents Google Cloud location. type Location struct { // DisplayName: The friendly name for this location, typically a nearby // city name. For example, "Tokyo".