From 186359d3bb564172a3839cfd1a2ce63da5204246 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Fri, 19 Aug 2022 07:19:44 +0000 Subject: [PATCH] feat(all): auto-regenerate discovery clients --- apigee/v1/apigee-api.json | 41 ++++- apigee/v1/apigee-gen.go | 63 ++++++- cloudsearch/v1/cloudsearch-api.json | 13 +- cloudsearch/v1/cloudsearch-gen.go | 8 - documentai/v1/documentai-api.json | 113 ++++++++++-- documentai/v1/documentai-gen.go | 166 ++++++++++++++--- documentai/v1beta2/documentai-api.json | 107 +++++++++-- documentai/v1beta2/documentai-gen.go | 157 +++++++++++++++-- documentai/v1beta3/documentai-api.json | 113 ++++++++++-- documentai/v1beta3/documentai-gen.go | 166 ++++++++++++++--- retail/v2/retail-api.json | 84 ++++----- retail/v2/retail-gen.go | 207 ++++++++++------------ retail/v2alpha/retail-api.json | 96 +++++----- retail/v2alpha/retail-gen.go | 235 +++++++++++-------------- retail/v2beta/retail-api.json | 84 ++++----- retail/v2beta/retail-gen.go | 207 ++++++++++------------ 16 files changed, 1243 insertions(+), 617 deletions(-) diff --git a/apigee/v1/apigee-api.json b/apigee/v1/apigee-api.json index 43b43ac8164..35539087287 100644 --- a/apigee/v1/apigee-api.json +++ b/apigee/v1/apigee-api.json @@ -8609,7 +8609,7 @@ } } }, - "revision": "20220804", + "revision": "20220811", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -8956,6 +8956,20 @@ "description": "Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.", "type": "string" }, + "quotaCounterScope": { + "description": "Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself.", + "enum": [ + "QUOTA_COUNTER_SCOPE_UNSPECIFIED", + "PROXY", + "OPERATION" + ], + "enumDescriptions": [ + "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association.", + "When quota is not explicitly defined for each operation(REST/GraphQL), set at product level will be used as a global counter for quota evaluation by all the operations associated with a particular proxy.", + "When quota is not explicitly defined for each operation(REST/GraphQL), the limits set at product level will be used as a local counter for quota evaluation by all the operations, independent of proxy association. This behavior mimics the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED." + ], + "type": "string" + }, "quotaInterval": { "description": "Time interval over which the number of request messages is calculated.", "type": "string" @@ -10752,6 +10766,31 @@ "description": "Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints).", "id": "GoogleCloudApigeeV1EndpointAttachment", "properties": { + "connectionState": { + "description": "Output only. State of the endpoint attachment connection to the service attachment.", + "enum": [ + "CONNECTION_STATE_UNSPECIFIED", + "UNAVAILABLE", + "PENDING", + "ACCEPTED", + "REJECTED", + "CLOSED", + "FROZEN", + "NEEDS_ATTENTION" + ], + "enumDescriptions": [ + "The connection state has not been set.", + "The connection state is unavailable at this time, possibly because the endpoint attachment is currently being provisioned.", + "The connection is pending acceptance by the PSC producer.", + "The connection has been accepted by the PSC producer.", + "The connection has been rejected by the PSC producer.", + "The connection has been closed by the PSC producer and will not serve traffic going forward.", + "The connection has been frozen by the PSC producer and will not serve traffic.", + "The connection has been accepted by the PSC producer, but it is not ready to serve the traffic due to producer side issues." + ], + "readOnly": true, + "type": "string" + }, "host": { "description": "Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.", "readOnly": true, diff --git a/apigee/v1/apigee-gen.go b/apigee/v1/apigee-gen.go index 0ae27ad7564..bda02dbb17e 100644 --- a/apigee/v1/apigee-gen.go +++ b/apigee/v1/apigee-gen.go @@ -1737,6 +1737,32 @@ type GoogleCloudApigeeV1ApiProduct struct { // hours. Quota string `json:"quota,omitempty"` + // QuotaCounterScope: Scope of the quota decides how the quota counter + // gets applied and evaluate for quota violation. If the Scope is set as + // PROXY, then all the operations defined for the APIproduct that are + // associated with the same proxy will share the same quota counter set + // at the APIproduct level, making it a global counter at a proxy level. + // If the Scope is set as OPERATION, then each operations get the + // counter set at the API product dedicated, making it a local counter. + // Note that, the QuotaCounterScope applies only when an operation does + // not have dedicated quota set for itself. + // + // Possible values: + // "QUOTA_COUNTER_SCOPE_UNSPECIFIED" - When quota is not explicitly + // defined for each operation(REST/GraphQL), the limits set at product + // level will be used as a local counter for quota evaluation by all the + // operations, independent of proxy association. + // "PROXY" - When quota is not explicitly defined for each + // operation(REST/GraphQL), set at product level will be used as a + // global counter for quota evaluation by all the operations associated + // with a particular proxy. + // "OPERATION" - When quota is not explicitly defined for each + // operation(REST/GraphQL), the limits set at product level will be used + // as a local counter for quota evaluation by all the operations, + // independent of proxy association. This behavior mimics the same as + // QUOTA_COUNTER_SCOPE_UNSPECIFIED. + QuotaCounterScope string `json:"quotaCounterScope,omitempty"` + // QuotaInterval: Time interval over which the number of request // messages is calculated. QuotaInterval string `json:"quotaInterval,omitempty"` @@ -4247,6 +4273,28 @@ func (s *GoogleCloudApigeeV1DimensionMetric) MarshalJSON() ([]byte, error) { // For more information, see [Southbound networking patterns] // (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). type GoogleCloudApigeeV1EndpointAttachment struct { + // ConnectionState: Output only. State of the endpoint attachment + // connection to the service attachment. + // + // Possible values: + // "CONNECTION_STATE_UNSPECIFIED" - The connection state has not been + // set. + // "UNAVAILABLE" - The connection state is unavailable at this time, + // possibly because the endpoint attachment is currently being + // provisioned. + // "PENDING" - The connection is pending acceptance by the PSC + // producer. + // "ACCEPTED" - The connection has been accepted by the PSC producer. + // "REJECTED" - The connection has been rejected by the PSC producer. + // "CLOSED" - The connection has been closed by the PSC producer and + // will not serve traffic going forward. + // "FROZEN" - The connection has been frozen by the PSC producer and + // will not serve traffic. + // "NEEDS_ATTENTION" - The connection has been accepted by the PSC + // producer, but it is not ready to serve the traffic due to producer + // side issues. + ConnectionState string `json:"connectionState,omitempty"` + // Host: Output only. Host that can be used in either the HTTP target // endpoint directly or as the host in target server. Host string `json:"host,omitempty"` @@ -4277,7 +4325,7 @@ type GoogleCloudApigeeV1EndpointAttachment struct { // server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "Host") to + // ForceSendFields is a list of field names (e.g. "ConnectionState") 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 @@ -4285,12 +4333,13 @@ type GoogleCloudApigeeV1EndpointAttachment struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Host") 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 is a list of field names (e.g. "ConnectionState") 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:"-"` } diff --git a/cloudsearch/v1/cloudsearch-api.json b/cloudsearch/v1/cloudsearch-api.json index 3697197cf4b..b39bf7d7725 100644 --- a/cloudsearch/v1/cloudsearch-api.json +++ b/cloudsearch/v1/cloudsearch-api.json @@ -2059,7 +2059,7 @@ } } }, - "revision": "20220808", + "revision": "20220816", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "AbuseReportingConfig": { @@ -5468,13 +5468,6 @@ "readOnly": true, "type": "array" }, - "supportedCaptionLanguages": { - "description": "Supported caption languages in BCP 47 language code format, e.g.'en-US'.", - "items": { - "type": "string" - }, - "type": "array" - }, "transcriptionSessionInfo": { "$ref": "TranscriptionSessionInfo", "description": "Information about active transcription session in the ongoing conference." @@ -15699,10 +15692,6 @@ "uri": { "description": "The uri for whiteboard document.", "type": "string" - }, - "whiteboardUri": { - "description": "This field is deprecated and will be removed. Please use \"uri\" instead.", - "type": "string" } }, "type": "object" diff --git a/cloudsearch/v1/cloudsearch-gen.go b/cloudsearch/v1/cloudsearch-gen.go index 49a96d0dabf..26058122eb8 100644 --- a/cloudsearch/v1/cloudsearch-gen.go +++ b/cloudsearch/v1/cloudsearch-gen.go @@ -5657,10 +5657,6 @@ type CallInfo struct { // session is included if there's no active one. StreamingSessions []*StreamingSessionInfo `json:"streamingSessions,omitempty"` - // SupportedCaptionLanguages: Supported caption languages in BCP 47 - // language code format, e.g.'en-US'. - SupportedCaptionLanguages []string `json:"supportedCaptionLanguages,omitempty"` - // TranscriptionSessionInfo: Information about active transcription // session in the ongoing conference. TranscriptionSessionInfo *TranscriptionSessionInfo `json:"transcriptionSessionInfo,omitempty"` @@ -21408,10 +21404,6 @@ type WhiteboardInfo struct { // Uri: The uri for whiteboard document. Uri string `json:"uri,omitempty"` - // WhiteboardUri: This field is deprecated and will be removed. Please - // use "uri" instead. - WhiteboardUri string `json:"whiteboardUri,omitempty"` - // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any diff --git a/documentai/v1/documentai-api.json b/documentai/v1/documentai-api.json index a7d63c85d90..ff7fd604867 100644 --- a/documentai/v1/documentai-api.json +++ b/documentai/v1/documentai-api.json @@ -1069,7 +1069,7 @@ } } }, - "revision": "20220808", + "revision": "20220815", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1085,6 +1085,11 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" }, "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -1099,7 +1104,7 @@ }, "status": { "$ref": "GoogleRpcStatus", - "description": "The status of deleting the document." + "description": "The status of deleting the document in storage." } }, "type": "object" @@ -1412,6 +1417,13 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long running operation." }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, "individualImportStatuses": { "description": "The list of response details of each document.", "items": { @@ -1427,6 +1439,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is ok if the configuration is valid and the specified documents are valid for importing. Otherwise status will be set as errors.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { "description": "The status of each individual document in the import process.", "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", @@ -1460,6 +1487,20 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long running operation." }, + "datasetResyncStatuses": { + "description": "The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" + }, + "type": "array" + }, + "individualDocumentResyncStatuses": { + "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" + }, + "type": "array" + }, "newlyAddedDocuments": { "description": "Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage.", "items": { @@ -1470,6 +1511,60 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { + "description": "Resync status against inconsistency types on the dataset level.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", + "properties": { + "datasetInconsistencyType": { + "description": "The type of the inconsistency of the dataset.", + "enum": [ + "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", + "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" + ], + "enumDescriptions": [ + "Default value.", + "The marker file under the dataset folder is not found." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { + "description": "Resync status for each document per inconsistency type.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document identifier." + }, + "documentInconsistencyType": { + "description": "The type of document inconsistency.", + "enum": [ + "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", + "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", + "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", + "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" + ], + "enumDescriptions": [ + "Default value.", + "The document proto is invalid.", + "Indexed docproto metadata is mismatched.", + "The page image or thumbnails are missing." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument": { "description": "The proto for updated document in resync pipeline.", "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument", @@ -2012,10 +2107,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." @@ -2889,7 +2980,7 @@ "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \u003e10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." }, "name": { - "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The '/' is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.", + "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The '/' is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.", "type": "string" }, "properties": { @@ -3890,10 +3981,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." @@ -5128,10 +5215,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." diff --git a/documentai/v1/documentai-gen.go b/documentai/v1/documentai-gen.go index c27037427f2..d36d6063b83 100644 --- a/documentai/v1/documentai-gen.go +++ b/documentai/v1/documentai-gen.go @@ -298,6 +298,9 @@ type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata struct { // document. IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"` + // TotalDocumentCount: Total number of documents deleting from dataset. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -329,7 +332,7 @@ type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDe // DocumentId: The document id of the document. DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"` - // Status: The status of deleting the document. + // Status: The status of deleting the document in storage. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "DocumentId") to @@ -950,6 +953,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + // ImportConfigValidationResults: Validation statuses of the batch + // documents import config. + ImportConfigValidationResults []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"` + // IndividualImportStatuses: The list of response details of each // document. IndividualImportStatuses []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"` @@ -982,6 +989,42 @@ func (s *GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValid +// ationResult: The validation status of each import config. Status is +// ok if the configuration is valid and the specified documents are +// valid for importing. Otherwise status will be set as errors. +type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult struct { + // InputGcsSource: The source Cloud Storage URI specified in the import + // config. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // Status: The validation status of import config. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") 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. "InputGcsSource") 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 *GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportS // tatus: The status of each individual document in the import process. type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus struct { @@ -1030,6 +1073,16 @@ type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + // DatasetResyncStatuses: The list of dataset resync statuses. Not + // checked when `dataset_documents` is specified in ResyncRequest. + DatasetResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus `json:"datasetResyncStatuses,omitempty"` + + // IndividualDocumentResyncStatuses: The list of document resync + // statuses. The same document could have multiple + // `individual_document_resync_statuses` if it has multiple + // inconsistencies. + IndividualDocumentResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus `json:"individualDocumentResyncStatuses,omitempty"` + // NewlyAddedDocuments: Returns the newly added document Cloud Storage // prefix if the documents are founded in Cloud Storage while not in // Document Service storage. @@ -1059,6 +1112,94 @@ func (s *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus +// : Resync status against inconsistency types on the dataset level. +type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus struct { + // DatasetInconsistencyType: The type of the inconsistency of the + // dataset. + // + // Possible values: + // "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value. + // "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" - The marker file + // under the dataset folder is not found. + DatasetInconsistencyType string `json:"datasetInconsistencyType,omitempty"` + + // Status: The status of resyncing the dataset with regards to the + // detected inconsistency. Empty if `validate_only` is true in the + // request. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DatasetInconsistencyType") 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. "DatasetInconsistencyType") + // 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 *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentR +// esyncStatus: Resync status for each document per inconsistency type. +type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus struct { + // DocumentId: The document identifier. + DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"` + + // DocumentInconsistencyType: The type of document inconsistency. + // + // Possible values: + // "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value. + // "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO" - The document proto + // is invalid. + // "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA" - Indexed + // docproto metadata is mismatched. + // "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" - The page image or + // thumbnails are missing. + DocumentInconsistencyType string `json:"documentInconsistencyType,omitempty"` + + // Status: The status of resyncing the document with regards to the + // detected inconsistency. Empty if `validate_only` is true in the + // request. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentId") 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. "DocumentId") 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 *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument: // The proto for updated document in resync pipeline. type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument struct { @@ -1966,13 +2107,6 @@ type GoogleCloudDocumentaiV1DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated @@ -3333,7 +3467,7 @@ type GoogleCloudDocumentaiV1DocumentSchemaEntityType struct { // cannot be a 'Common Type'. Besides that we use the following naming // conventions: - *use snake_casing* - name matching is case-insensitive // - Maximum 64 characters. - Must start with a letter. - Allowed - // characters: ASCII letters [a-z0-9_-]. (For backward compatibility + // characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility // internal infrastructure and tooling can handle any ascii character) - // The '/' is sometimes used to denote a property of a type. For example // line_item/amount. This convention is deprecated, but will still be @@ -5080,13 +5214,6 @@ type GoogleCloudDocumentaiV1beta1DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated @@ -7085,13 +7212,6 @@ type GoogleCloudDocumentaiV1beta2DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated diff --git a/documentai/v1beta2/documentai-api.json b/documentai/v1beta2/documentai-api.json index 6d1c6650831..46375a7456f 100644 --- a/documentai/v1beta2/documentai-api.json +++ b/documentai/v1beta2/documentai-api.json @@ -292,7 +292,7 @@ } } }, - "revision": "20220808", + "revision": "20220815", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -308,6 +308,11 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" }, "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -322,7 +327,7 @@ }, "status": { "$ref": "GoogleRpcStatus", - "description": "The status of deleting the document." + "description": "The status of deleting the document in storage." } }, "type": "object" @@ -635,6 +640,13 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long running operation." }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, "individualImportStatuses": { "description": "The list of response details of each document.", "items": { @@ -650,6 +662,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is ok if the configuration is valid and the specified documents are valid for importing. Otherwise status will be set as errors.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { "description": "The status of each individual document in the import process.", "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", @@ -683,6 +710,20 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long running operation." }, + "datasetResyncStatuses": { + "description": "The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" + }, + "type": "array" + }, + "individualDocumentResyncStatuses": { + "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" + }, + "type": "array" + }, "newlyAddedDocuments": { "description": "Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage.", "items": { @@ -693,6 +734,60 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { + "description": "Resync status against inconsistency types on the dataset level.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", + "properties": { + "datasetInconsistencyType": { + "description": "The type of the inconsistency of the dataset.", + "enum": [ + "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", + "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" + ], + "enumDescriptions": [ + "Default value.", + "The marker file under the dataset folder is not found." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { + "description": "Resync status for each document per inconsistency type.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document identifier." + }, + "documentInconsistencyType": { + "description": "The type of document inconsistency.", + "enum": [ + "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", + "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", + "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", + "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" + ], + "enumDescriptions": [ + "Default value.", + "The document proto is invalid.", + "Indexed docproto metadata is mismatched.", + "The page image or thumbnails are missing." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument": { "description": "The proto for updated document in resync pipeline.", "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument", @@ -1387,10 +1482,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." @@ -2650,10 +2741,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." diff --git a/documentai/v1beta2/documentai-gen.go b/documentai/v1beta2/documentai-gen.go index 65134dbaf6e..6bb5e9a843e 100644 --- a/documentai/v1beta2/documentai-gen.go +++ b/documentai/v1beta2/documentai-gen.go @@ -214,6 +214,9 @@ type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata struct { // document. IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"` + // TotalDocumentCount: Total number of documents deleting from dataset. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -245,7 +248,7 @@ type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDe // DocumentId: The document id of the document. DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"` - // Status: The status of deleting the document. + // Status: The status of deleting the document in storage. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "DocumentId") to @@ -866,6 +869,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + // ImportConfigValidationResults: Validation statuses of the batch + // documents import config. + ImportConfigValidationResults []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"` + // IndividualImportStatuses: The list of response details of each // document. IndividualImportStatuses []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"` @@ -898,6 +905,42 @@ func (s *GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValid +// ationResult: The validation status of each import config. Status is +// ok if the configuration is valid and the specified documents are +// valid for importing. Otherwise status will be set as errors. +type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult struct { + // InputGcsSource: The source Cloud Storage URI specified in the import + // config. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // Status: The validation status of import config. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") 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. "InputGcsSource") 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 *GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportS // tatus: The status of each individual document in the import process. type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus struct { @@ -946,6 +989,16 @@ type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + // DatasetResyncStatuses: The list of dataset resync statuses. Not + // checked when `dataset_documents` is specified in ResyncRequest. + DatasetResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus `json:"datasetResyncStatuses,omitempty"` + + // IndividualDocumentResyncStatuses: The list of document resync + // statuses. The same document could have multiple + // `individual_document_resync_statuses` if it has multiple + // inconsistencies. + IndividualDocumentResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus `json:"individualDocumentResyncStatuses,omitempty"` + // NewlyAddedDocuments: Returns the newly added document Cloud Storage // prefix if the documents are founded in Cloud Storage while not in // Document Service storage. @@ -975,6 +1028,94 @@ func (s *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus +// : Resync status against inconsistency types on the dataset level. +type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus struct { + // DatasetInconsistencyType: The type of the inconsistency of the + // dataset. + // + // Possible values: + // "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value. + // "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" - The marker file + // under the dataset folder is not found. + DatasetInconsistencyType string `json:"datasetInconsistencyType,omitempty"` + + // Status: The status of resyncing the dataset with regards to the + // detected inconsistency. Empty if `validate_only` is true in the + // request. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DatasetInconsistencyType") 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. "DatasetInconsistencyType") + // 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 *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentR +// esyncStatus: Resync status for each document per inconsistency type. +type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus struct { + // DocumentId: The document identifier. + DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"` + + // DocumentInconsistencyType: The type of document inconsistency. + // + // Possible values: + // "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value. + // "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO" - The document proto + // is invalid. + // "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA" - Indexed + // docproto metadata is mismatched. + // "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" - The page image or + // thumbnails are missing. + DocumentInconsistencyType string `json:"documentInconsistencyType,omitempty"` + + // Status: The status of resyncing the document with regards to the + // detected inconsistency. Empty if `validate_only` is true in the + // request. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentId") 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. "DocumentId") 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 *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument: // The proto for updated document in resync pipeline. type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument struct { @@ -2148,13 +2289,6 @@ type GoogleCloudDocumentaiV1beta1DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated @@ -4217,13 +4351,6 @@ type GoogleCloudDocumentaiV1beta2DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated diff --git a/documentai/v1beta3/documentai-api.json b/documentai/v1beta3/documentai-api.json index feba2e0f294..70249ed2a18 100644 --- a/documentai/v1beta3/documentai-api.json +++ b/documentai/v1beta3/documentai-api.json @@ -836,7 +836,7 @@ } } }, - "revision": "20220808", + "revision": "20220815", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -852,6 +852,11 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" }, "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -866,7 +871,7 @@ }, "status": { "$ref": "GoogleRpcStatus", - "description": "The status of deleting the document." + "description": "The status of deleting the document in storage." } }, "type": "object" @@ -1179,6 +1184,13 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long running operation." }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, "individualImportStatuses": { "description": "The list of response details of each document.", "items": { @@ -1194,6 +1206,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is ok if the configuration is valid and the specified documents are valid for importing. Otherwise status will be set as errors.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { "description": "The status of each individual document in the import process.", "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", @@ -1227,6 +1254,20 @@ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long running operation." }, + "datasetResyncStatuses": { + "description": "The list of dataset resync statuses. Not checked when `dataset_documents` is specified in ResyncRequest.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" + }, + "type": "array" + }, + "individualDocumentResyncStatuses": { + "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" + }, + "type": "array" + }, "newlyAddedDocuments": { "description": "Returns the newly added document Cloud Storage prefix if the documents are founded in Cloud Storage while not in Document Service storage.", "items": { @@ -1237,6 +1278,60 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { + "description": "Resync status against inconsistency types on the dataset level.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", + "properties": { + "datasetInconsistencyType": { + "description": "The type of the inconsistency of the dataset.", + "enum": [ + "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", + "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" + ], + "enumDescriptions": [ + "Default value.", + "The marker file under the dataset folder is not found." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if `validate_only` is true in the request." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { + "description": "Resync status for each document per inconsistency type.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document identifier." + }, + "documentInconsistencyType": { + "description": "The type of document inconsistency.", + "enum": [ + "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", + "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", + "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", + "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" + ], + "enumDescriptions": [ + "Default value.", + "The document proto is invalid.", + "Indexed docproto metadata is mismatched.", + "The page image or thumbnails are missing." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if `validate_only` is true in the request." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument": { "description": "The proto for updated document in resync pipeline.", "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument", @@ -1931,10 +2026,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." @@ -3169,10 +3260,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." @@ -4678,10 +4765,6 @@ "description": "Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty.", "type": "string" }, - "nonPresent": { - "description": "Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor.", - "type": "boolean" - }, "normalizedValue": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue", "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." @@ -5555,7 +5638,7 @@ "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \u003e10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." }, "name": { - "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The '/' is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.", + "description": "Name of the type. It must be unique within the schema file and cannot be a 'Common Type'. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character) - The '/' is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.", "type": "string" }, "properties": { diff --git a/documentai/v1beta3/documentai-gen.go b/documentai/v1beta3/documentai-gen.go index 2d507bd5300..5fa3f027047 100644 --- a/documentai/v1beta3/documentai-gen.go +++ b/documentai/v1beta3/documentai-gen.go @@ -226,6 +226,9 @@ type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata struct { // document. IndividualBatchDeleteStatuses []*GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus `json:"individualBatchDeleteStatuses,omitempty"` + // TotalDocumentCount: Total number of documents deleting from dataset. + TotalDocumentCount int64 `json:"totalDocumentCount,omitempty"` + // ForceSendFields is a list of field names (e.g. "CommonMetadata") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -257,7 +260,7 @@ type GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDe // DocumentId: The document id of the document. DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"` - // Status: The status of deleting the document. + // Status: The status of deleting the document in storage. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "DocumentId") to @@ -878,6 +881,10 @@ type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + // ImportConfigValidationResults: Validation statuses of the batch + // documents import config. + ImportConfigValidationResults []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult `json:"importConfigValidationResults,omitempty"` + // IndividualImportStatuses: The list of response details of each // document. IndividualImportStatuses []*GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus `json:"individualImportStatuses,omitempty"` @@ -910,6 +917,42 @@ func (s *GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValid +// ationResult: The validation status of each import config. Status is +// ok if the configuration is valid and the specified documents are +// valid for importing. Otherwise status will be set as errors. +type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult struct { + // InputGcsSource: The source Cloud Storage URI specified in the import + // config. + InputGcsSource string `json:"inputGcsSource,omitempty"` + + // Status: The validation status of import config. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InputGcsSource") 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. "InputGcsSource") 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 *GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportS // tatus: The status of each individual document in the import process. type GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus struct { @@ -958,6 +1001,16 @@ type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata struct { // CommonMetadata: The basic metadata of the long running operation. CommonMetadata *GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata `json:"commonMetadata,omitempty"` + // DatasetResyncStatuses: The list of dataset resync statuses. Not + // checked when `dataset_documents` is specified in ResyncRequest. + DatasetResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus `json:"datasetResyncStatuses,omitempty"` + + // IndividualDocumentResyncStatuses: The list of document resync + // statuses. The same document could have multiple + // `individual_document_resync_statuses` if it has multiple + // inconsistencies. + IndividualDocumentResyncStatuses []*GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus `json:"individualDocumentResyncStatuses,omitempty"` + // NewlyAddedDocuments: Returns the newly added document Cloud Storage // prefix if the documents are founded in Cloud Storage while not in // Document Service storage. @@ -987,6 +1040,94 @@ func (s *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus +// : Resync status against inconsistency types on the dataset level. +type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus struct { + // DatasetInconsistencyType: The type of the inconsistency of the + // dataset. + // + // Possible values: + // "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value. + // "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" - The marker file + // under the dataset folder is not found. + DatasetInconsistencyType string `json:"datasetInconsistencyType,omitempty"` + + // Status: The status of resyncing the dataset with regards to the + // detected inconsistency. Empty if `validate_only` is true in the + // request. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DatasetInconsistencyType") 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. "DatasetInconsistencyType") + // 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 *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentR +// esyncStatus: Resync status for each document per inconsistency type. +type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus struct { + // DocumentId: The document identifier. + DocumentId *GoogleCloudDocumentaiUiv1beta3DocumentId `json:"documentId,omitempty"` + + // DocumentInconsistencyType: The type of document inconsistency. + // + // Possible values: + // "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED" - Default value. + // "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO" - The document proto + // is invalid. + // "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA" - Indexed + // docproto metadata is mismatched. + // "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" - The page image or + // thumbnails are missing. + DocumentInconsistencyType string `json:"documentInconsistencyType,omitempty"` + + // Status: The status of resyncing the document with regards to the + // detected inconsistency. Empty if `validate_only` is true in the + // request. + Status *GoogleRpcStatus `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DocumentId") 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. "DocumentId") 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 *GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument: // The proto for updated document in resync pipeline. type GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataUpdatedDocument struct { @@ -2160,13 +2301,6 @@ type GoogleCloudDocumentaiV1beta1DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated @@ -4165,13 +4299,6 @@ type GoogleCloudDocumentaiV1beta2DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated @@ -6646,13 +6773,6 @@ type GoogleCloudDocumentaiV1beta3DocumentEntity struct { // this field will be empty. MentionText string `json:"mentionText,omitempty"` - // NonPresent: Optional. This attribute indicates that the processing - // didn't actually identify this entity, but a confidence score was - // assigned that represent the potential that this could be a false - // negative. A non-present entity should have an empty mention_text and - // text_anchor. - NonPresent bool `json:"nonPresent,omitempty"` - // NormalizedValue: Optional. Normalized entity value. Absent if the // extracted value could not be converted or the type (e.g. address) is // not supported for certain parsers. This field is also only populated @@ -8015,7 +8135,7 @@ type GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType struct { // cannot be a 'Common Type'. Besides that we use the following naming // conventions: - *use snake_casing* - name matching is case-insensitive // - Maximum 64 characters. - Must start with a letter. - Allowed - // characters: ASCII letters [a-z0-9_-]. (For backward compatibility + // characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility // internal infrastructure and tooling can handle any ascii character) - // The '/' is sometimes used to denote a property of a type. For example // line_item/amount. This convention is deprecated, but will still be diff --git a/retail/v2/retail-api.json b/retail/v2/retail-api.json index bfc3b484a08..f7dacc0450d 100644 --- a/retail/v2/retail-api.json +++ b/retail/v2/retail-api.json @@ -505,7 +505,7 @@ "products": { "methods": { "addFulfillmentPlaces": { - "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -533,7 +533,7 @@ ] }, "addLocalInventories": { - "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -758,7 +758,7 @@ ] }, "removeFulfillmentPlaces": { - "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -786,7 +786,7 @@ ] }, "removeLocalInventories": { - "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -814,7 +814,7 @@ ] }, "setInventory": { - "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -1111,7 +1111,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", + "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.userEvents.import", @@ -2005,11 +2005,11 @@ "type": "object" }, "GoogleCloudRetailV2GcsSource": { - "description": "Google Cloud Storage location for input content.", + "description": "Google Cloud Storage location for input content. format.", "id": "GoogleCloudRetailV2GcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * `control` (default): One JSON Control per line. Supported values for catalog attribute imports: * `catalog_attribute` (default): One CSV CatalogAttribute per line.", + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * 'control' (default): One JSON Control per line. Supported values for catalog attribute imports: * 'catalog_attribute' (default): One CSV CatalogAttribute per line.", "type": "string" }, "inputUris": { @@ -2072,7 +2072,7 @@ "description": "Required. The desired input location of the data." }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" } }, @@ -2097,14 +2097,14 @@ "id": "GoogleCloudRetailV2ImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2ImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2ImportMetadata", "properties": { "createTime": { @@ -2118,7 +2118,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -2151,7 +2151,7 @@ "description": "Required. The desired input location of the data." }, "notificationPubsubTopic": { - "description": "Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.", + "description": "Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.", "type": "string" }, "reconciliationMode": { @@ -2173,7 +2173,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported `products` to update. If not set, all fields are updated.", + "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", "format": "google-fieldmask", "type": "string" } @@ -3826,14 +3826,14 @@ "id": "GoogleCloudRetailV2alphaImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2alphaImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2alphaImportMetadata", "properties": { "createTime": { @@ -3847,7 +3847,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -3912,7 +3912,7 @@ "type": "object" }, "GoogleCloudRetailV2alphaModel": { - "description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.", + "description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict api.", "id": "GoogleCloudRetailV2alphaModel", "properties": { "createTime": { @@ -3922,14 +3922,14 @@ "type": "string" }, "dataState": { - "description": "Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.", + "description": "Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.", "enum": [ "DATA_STATE_UNSPECIFIED", "DATA_OK", "DATA_ERROR" ], "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", + "Unspecified default value - should never be explicitly set.", "The model has sufficient training data.", "The model does not have sufficient training data. Error messages can be queried via Stackdriver." ], @@ -3937,11 +3937,11 @@ "type": "string" }, "displayName": { - "description": "Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "description": "Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "filteringOption": { - "description": "Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.", + "description": "Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.", "enum": [ "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED", "RECOMMENDATIONS_FILTERING_DISABLED", @@ -3961,7 +3961,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", + "description": "Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", "type": "string" }, "optimizationObjective": { @@ -3973,7 +3973,7 @@ "description": "Optional. The page optimization config." }, "periodicTuningState": { - "description": "Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.", + "description": "Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED.", "enum": [ "PERIODIC_TUNING_STATE_UNSPECIFIED", "PERIODIC_TUNING_DISABLED", @@ -3981,10 +3981,10 @@ "PERIODIC_TUNING_ENABLED" ], "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", - "The model has periodic tuning disabled. Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or by calling the `TuneModel` method.", - "The model cannot be tuned with periodic tuning OR the `TuneModel` method. Hide the options in customer UI and reject any requests through the backend self serve API.", - "The model has periodic tuning enabled. Tuning can be disabled by calling the `DisableModelPeriodicTuning` method." + "Unspecified default value - should never be explicitly set.", + "The model has periodic tuning disabled. Tuning can be reenabled by calling the EnableModelPeriodicTuning method or by calling the TuneModel method.", + "The model cannot be tuned with periodic tuning OR the TuneModel method. Hide the options in customer UI and reject any requests through the backend self serve API.", + "The model has periodic tuning enabled. Tuning can be disabled by calling the DisableModelPeriodicTuning method." ], "type": "string" }, @@ -3997,7 +3997,7 @@ "type": "array" }, "servingState": { - "description": "Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.", + "description": "Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.", "enum": [ "SERVING_STATE_UNSPECIFIED", "INACTIVE", @@ -4008,13 +4008,13 @@ "Unspecified serving state.", "The model is not serving.", "The model is serving and can be queried.", - "The model is trained on tuned hyperparameters and can be queried." + "The model is trained on tuned hyperparameters, and can be queried." ], "readOnly": true, "type": "string" }, "trainingState": { - "description": "Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.", + "description": "Optional. The training state that the model is in (e.g. TRAINING or PAUSED). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. the default value for UpdateModel method is to keep the state the same as before.", "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", @@ -4033,7 +4033,7 @@ "type": "string" }, "type": { - "description": "Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(readonly value).", + "description": "Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(readonly value).", "type": "string" }, "updateTime": { @@ -4072,9 +4072,9 @@ "enumDescriptions": [ "Unspecified value for restriction.", "Allow any ServingConfig to be show on any number of panels. Example: `Panel1 candidates`: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity `Panel2 candidates`: home_page_ctr_no_diversity, home_page_ctr_diversity, pdp_cvr_no_diversity `Restriction` = NO_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: []", - "Do not allow the same ServingConfig.name to be shown on multiple panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *", - "Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) *", - "Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) *" + "Do not allow the same ServingConfig.name to be shown on multiple panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_SERVING_CONFIG_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *", + "Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) *", + "Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) *" ], "type": "string" } @@ -4086,7 +4086,7 @@ "id": "GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate", "properties": { "servingConfigId": { - "description": "This has to be a valid ServingConfig identifier. For example, for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config`, this would be `my_candidate_config`.", + "description": "This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config` this would be 'my_candidate_config'", "type": "string" } }, @@ -4105,7 +4105,7 @@ }, "defaultCandidate": { "$ref": "GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate", - "description": "Required. The default candidate. If the model fails at serving time, we fall back to the default." + "description": "Required. The default candidate (in case the model fails at serving time, we can fall back to the default)." }, "displayName": { "description": "Optional. The name to display for the panel.", @@ -4115,11 +4115,11 @@ "type": "object" }, "GoogleCloudRetailV2alphaModelServingConfigList": { - "description": "Represents an ordered combination of valid serving configs, which can be used for `PAGE_OPTIMIZATION` recommendations.", + "description": "Represents an ordered combination of valid serving configs, which / may be used for PAGE_OPTIMIZATION recommendations.", "id": "GoogleCloudRetailV2alphaModelServingConfigList", "properties": { "servingConfigIds": { - "description": "Optional. A set of valid serving configs that may be used for `PAGE_OPTIMIZATION`.", + "description": "Optional. A set of valid serving configs that may be used for PAGE_OPTIMIZATION.", "items": { "type": "string" }, @@ -4441,14 +4441,14 @@ "id": "GoogleCloudRetailV2betaImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2betaImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2betaImportMetadata", "properties": { "createTime": { @@ -4462,7 +4462,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { diff --git a/retail/v2/retail-gen.go b/retail/v2/retail-gen.go index 4694093ef57..3b5acadf44d 100644 --- a/retail/v2/retail-gen.go +++ b/retail/v2/retail-gen.go @@ -1515,7 +1515,7 @@ func (s *GoogleCloudRetailV2FulfillmentInfo) MarshalJSON() ([]byte, error) { } // GoogleCloudRetailV2GcsSource: Google Cloud Storage location for input -// content. +// content. format. type GoogleCloudRetailV2GcsSource struct { // DataSchema: The schema to use when parsing the data from the source. // Supported values for product imports: * `product` (default): One JSON @@ -1526,9 +1526,9 @@ type GoogleCloudRetailV2GcsSource struct { // Supported values for user events imports: * `user_event` (default): // One JSON UserEvent per line. * `user_event_ga360`: Using // https://support.google.com/analytics/answer/3437719. Supported values - // for control imports: * `control` (default): One JSON Control per + // for control imports: * 'control' (default): One JSON Control per // line. Supported values for catalog attribute imports: * - // `catalog_attribute` (default): One CSV CatalogAttribute per line. + // 'catalog_attribute' (default): One CSV CatalogAttribute per line. DataSchema string `json:"dataSchema,omitempty"` // InputUris: Required. Google Cloud Storage URIs to input files. URI @@ -1655,9 +1655,9 @@ type GoogleCloudRetailV2ImportCompletionDataRequest struct { InputConfig *GoogleCloudRetailV2CompletionDataInputConfig `json:"inputConfig,omitempty"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -1721,7 +1721,7 @@ func (s *GoogleCloudRetailV2ImportCompletionDataResponse) MarshalJSON() ([]byte, // for Import related errors. type GoogleCloudRetailV2ImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -1750,7 +1750,7 @@ func (s *GoogleCloudRetailV2ImportErrorsConfig) MarshalJSON() ([]byte, error) { } // GoogleCloudRetailV2ImportMetadata: Metadata related to the progress -// of the Import operation. This is returned by the +// of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2ImportMetadata struct { // CreateTime: Operation create time. @@ -1761,9 +1761,9 @@ type GoogleCloudRetailV2ImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -1812,9 +1812,9 @@ type GoogleCloudRetailV2ImportProductsRequest struct { // NotificationPubsubTopic: Full Pub/Sub topic name for receiving // notification. If this field is set, when the import is finished, a - // notification is sent to specified Pub/Sub topic. The message data is - // JSON string of a Operation. Format of the Pub/Sub topic is - // `projects/{project}/topics/{topic}`. It has to be within the same + // notification will be sent to specified Pub/Sub topic. The message + // data will be JSON string of a Operation. Format of the Pub/Sub topic + // is `projects/{project}/topics/{topic}`. It has to be within the same // project as ImportProductsRequest.parent. Make sure that // `service-@gcp-sa-retail.iam.gserviceaccount.com` has the // `pubsub.topics.publish` IAM permission on the topic. @@ -1836,7 +1836,7 @@ type GoogleCloudRetailV2ImportProductsRequest struct { RequestId string `json:"requestId,omitempty"` // UpdateMask: Indicates which fields in the provided imported - // `products` to update. If not set, all fields are updated. + // 'products' to update. If not set, will by default update all fields. UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorsConfig") to @@ -5196,7 +5196,7 @@ func (s *GoogleCloudRetailV2alphaImportCompletionDataResponse) MarshalJSON() ([] // destination for Import related errors. type GoogleCloudRetailV2alphaImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -5225,7 +5225,7 @@ func (s *GoogleCloudRetailV2alphaImportErrorsConfig) MarshalJSON() ([]byte, erro } // GoogleCloudRetailV2alphaImportMetadata: Metadata related to the -// progress of the Import operation. This is returned by the +// progress of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2alphaImportMetadata struct { // CreateTime: Operation create time. @@ -5236,9 +5236,9 @@ type GoogleCloudRetailV2alphaImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -5358,21 +5358,21 @@ func (s *GoogleCloudRetailV2alphaImportUserEventsResponse) MarshalJSON() ([]byte // GoogleCloudRetailV2alphaModel: Metadata that describes the training // and serving parameters of a Model. A Model can be associated with a -// ServingConfig and then queried through the Predict API. +// ServingConfig and then queried through the Predict api. type GoogleCloudRetailV2alphaModel struct { // CreateTime: Output only. Timestamp the Recommendation Model was // created at. CreateTime string `json:"createTime,omitempty"` // DataState: Output only. The state of data requirements for this - // model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be - // trained if the data is in `DATA_ERROR` state. Recommendation model - // can have `DATA_ERROR` state even if serving state is `ACTIVE`: models - // were trained successfully before, but cannot be refreshed because - // model no longer has sufficient data for training. + // model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained + // if the data is in DATA_ERROR state. Recommendation model can have + // DATA_ERROR state even if serving state is ACTIVE: models were trained + // successfully before, but cannot be refreshed because model no longer + // has sufficient data for training. // // Possible values: - // "DATA_STATE_UNSPECIFIED" - Unspecified default value, should never + // "DATA_STATE_UNSPECIFIED" - Unspecified default value - should never // be explicitly set. // "DATA_OK" - The model has sufficient training data. // "DATA_ERROR" - The model does not have sufficient training data. @@ -5381,11 +5381,10 @@ type GoogleCloudRetailV2alphaModel struct { // DisplayName: Required. The display name of the model. Should be human // readable, used to display Recommendation Models in the Retail Cloud - // Console Dashboard. UTF-8 encoded string with limit of 1024 - // characters. + // Cosole Dashboard. UTF-8 encoded string with limit of 1024 characters. DisplayName string `json:"displayName,omitempty"` - // FilteringOption: Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, + // FilteringOption: Optional. If RECOMMENDATIONS_FILTERING_ENABLED, // recommendation filtering by attributes is enabled for the model. // // Possible values: @@ -5404,8 +5403,8 @@ type GoogleCloudRetailV2alphaModel struct { // Name: Required. The fully qualified resource name of the model. // Format: - // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_i - // d}/models/{model_id}` catalog_id has char limit of 50. + // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id + // }/models/{model_id} catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. Name string `json:"name,omitempty"` @@ -5422,20 +5421,19 @@ type GoogleCloudRetailV2alphaModel struct { // PeriodicTuningState: Optional. The state of periodic tuning. The // period we use is 3 months - to do a one-off tune earlier use the - // `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. + // TuneModel method. Default value is PERIODIC_TUNING_ENABLED. // // Possible values: - // "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value, + // "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value - // should never be explicitly set. // "PERIODIC_TUNING_DISABLED" - The model has periodic tuning // disabled. Tuning can be reenabled by calling the - // `EnableModelPeriodicTuning` method or by calling the `TuneModel` - // method. + // EnableModelPeriodicTuning method or by calling the TuneModel method. // "ALL_TUNING_DISABLED" - The model cannot be tuned with periodic - // tuning OR the `TuneModel` method. Hide the options in customer UI and + // tuning OR the TuneModel method. Hide the options in customer UI and // reject any requests through the backend self serve API. // "PERIODIC_TUNING_ENABLED" - The model has periodic tuning enabled. - // Tuning can be disabled by calling the `DisableModelPeriodicTuning` + // Tuning can be disabled by calling the DisableModelPeriodicTuning // method. PeriodicTuningState string `json:"periodicTuningState,omitempty"` @@ -5443,24 +5441,23 @@ type GoogleCloudRetailV2alphaModel struct { // associated with the PageOptimizationConfig. ServingConfigLists []*GoogleCloudRetailV2alphaModelServingConfigList `json:"servingConfigLists,omitempty"` - // ServingState: Output only. The serving state of the model: `ACTIVE`, - // `NOT_ACTIVE`. + // ServingState: Output only. The serving state of the model: ACTIVE, + // NOT_ACTIVE. // // Possible values: // "SERVING_STATE_UNSPECIFIED" - Unspecified serving state. // "INACTIVE" - The model is not serving. // "ACTIVE" - The model is serving and can be queried. - // "TUNED" - The model is trained on tuned hyperparameters and can be + // "TUNED" - The model is trained on tuned hyperparameters, and can be // queried. ServingState string `json:"servingState,omitempty"` // TrainingState: Optional. The training state that the model is in - // (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the + // (e.g. TRAINING or PAUSED). Since part of the cost of running the // service is frequency of training - this can be used to determine when // to train model in order to control cost. If not specified: the - // default value for `CreateModel` method is `TRAINING`. The default - // value for `UpdateModel` method is to keep the state the same as - // before. + // default value for CreateModel method is TRAINING. the default value + // for UpdateModel method is to keep the state the same as before. // // Possible values: // "TRAINING_STATE_UNSPECIFIED" - Unspecified training state. @@ -5475,8 +5472,8 @@ type GoogleCloudRetailV2alphaModel struct { // Type: Required. The type of model e.g. `home-page`. Currently // supported values: `recommended-for-you`, `others-you-may-like`, - // `frequently-bought-together`, `page-optimization`, `similar-items`, - // `buy-it-again`, and `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, 'similar-items', + // 'buy-it-again', `recently-viewed`(readonly value). Type string `json:"type,omitempty"` // UpdateTime: Output only. Timestamp the Recommendation Model was last @@ -5553,21 +5550,21 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct { // candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 // candidates`: * home_page_ctr_no_diversity, // home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = - // `UNIQUE_SERVING_CONFIG_RESTRICTION` `Valid combinations`: * * - // (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, - // home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * - // (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, - // home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) - // * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, - // home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, - // pdp_cvr_no_diversity) * `Invalid combinations`: * * - // (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * + // UNIQUE_SERVING_CONFIG_RESTRICTION `Valid combinations`: * * (pdp_ctr, + // home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) + // * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * + // (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, + // home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * + // (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * + // (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid + // combinations`: * * (home_page_ctr_no_diversity, + // home_page_ctr_no_diversity) * // "UNIQUE_MODEL_RESTRICTION" - Do not allow multiple ServingConfigs // with same Model.name to be show on on different panels. Example: // `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * // `Panel2 candidates`: * home_page_ctr_no_diversity, // home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = - // `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, + // UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, // home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * // (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * // (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, @@ -5580,7 +5577,7 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct { // Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, // home_page_ctr_no_diversity * `Panel2 candidates`: * // home_page_ctr_no_diversity, home_page_ctr_diversity_low, - // pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` + // pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION // `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * // (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, // home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) @@ -5620,10 +5617,10 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfig) MarshalJSON() ([]b // candidate to consider for a given panel. Currently only ServingConfig // are valid candidates. type GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate struct { - // ServingConfigId: This has to be a valid ServingConfig identifier. For - // example, for a ServingConfig with full name: + // ServingConfigId: This has to be a valid ServingConfig identifier. + // e.g. for a ServingConfig with full name: // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/m - // y_candidate_config`, this would be `my_candidate_config`. + // y_candidate_config` this would be 'my_candidate_config' ServingConfigId string `json:"servingConfigId,omitempty"` // ForceSendFields is a list of field names (e.g. "ServingConfigId") to @@ -5657,8 +5654,8 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct { // = 10. Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"` - // DefaultCandidate: Required. The default candidate. If the model fails - // at serving time, we fall back to the default. + // DefaultCandidate: Required. The default candidate (in case the model + // fails at serving time, we can fall back to the default). DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"` // DisplayName: Optional. The name to display for the panel. @@ -5688,11 +5685,11 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel) MarshalJSON() } // GoogleCloudRetailV2alphaModelServingConfigList: Represents an ordered -// combination of valid serving configs, which can be used for -// `PAGE_OPTIMIZATION` recommendations. +// combination of valid serving configs, which / may be used for +// PAGE_OPTIMIZATION recommendations. type GoogleCloudRetailV2alphaModelServingConfigList struct { // ServingConfigIds: Optional. A set of valid serving configs that may - // be used for `PAGE_OPTIMIZATION`. + // be used for PAGE_OPTIMIZATION. ServingConfigIds []string `json:"servingConfigIds,omitempty"` // ForceSendFields is a list of field names (e.g. "ServingConfigIds") to @@ -6295,7 +6292,7 @@ func (s *GoogleCloudRetailV2betaImportCompletionDataResponse) MarshalJSON() ([]b // destination for Import related errors. type GoogleCloudRetailV2betaImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -6324,7 +6321,7 @@ func (s *GoogleCloudRetailV2betaImportErrorsConfig) MarshalJSON() ([]byte, error } // GoogleCloudRetailV2betaImportMetadata: Metadata related to the -// progress of the Import operation. This is returned by the +// progress of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2betaImportMetadata struct { // CreateTime: Operation create time. @@ -6335,9 +6332,9 @@ type GoogleCloudRetailV2betaImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -8846,12 +8843,9 @@ type ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall struct { // processed downstream. As a consequence, when a response is returned, // the added place IDs are not immediately manifested in the Product // queried by ProductService.GetProduct or ProductService.ListProducts. -// The returned Operations will be obsolete after 1 day, and -// GetOperation API will return NOT_FOUND afterwards. If conflicting -// updates are issued, the Operations associated with the stale updates -// will not be marked as done until being obsolete. This feature is only -// available for users who have Retail Search enabled. Please enable -// Retail Search on Cloud Console before using this feature. +// This feature is only available for users who have Retail Search +// enabled. Please enable Retail Search on Cloud Console before using +// this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -8956,7 +8950,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall) Do(o } return ret, nil // { - // "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -9007,13 +9001,9 @@ type ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall struct { // ProductService.GetProduct or ProductService.ListProducts. Local // inventory information can only be modified using this method. // ProductService.CreateProduct and ProductService.UpdateProduct has no -// effect on local inventories. The returned Operations will be obsolete -// after 1 day, and GetOperation API will return NOT_FOUND afterwards. -// If conflicting updates are issued, the Operations associated with the -// stale updates will not be marked as done until being obsolete. This -// feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this -// feature. +// effect on local inventories. This feature is only available for users +// who have Retail Search enabled. Please enable Retail Search on Cloud +// Console before using this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -9118,7 +9108,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall) Do(op } return ret, nil // { - // "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -10190,12 +10180,9 @@ type ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall struct // processed downstream. As a consequence, when a response is returned, // the removed place IDs are not immediately manifested in the Product // queried by ProductService.GetProduct or ProductService.ListProducts. -// The returned Operations will be obsolete after 1 day, and -// GetOperation API will return NOT_FOUND afterwards. If conflicting -// updates are issued, the Operations associated with the stale updates -// will not be marked as done until being obsolete. This feature is only -// available for users who have Retail Search enabled. Please enable -// Retail Search on Cloud Console before using this feature. +// This feature is only available for users who have Retail Search +// enabled. Please enable Retail Search on Cloud Console before using +// this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10300,7 +10287,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall) D } return ret, nil // { - // "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -10349,13 +10336,9 @@ type ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall struct // queried by ProductService.GetProduct or ProductService.ListProducts. // Local inventory information can only be removed using this method. // ProductService.CreateProduct and ProductService.UpdateProduct has no -// effect on local inventories. The returned Operations will be obsolete -// after 1 day, and GetOperation API will return NOT_FOUND afterwards. -// If conflicting updates are issued, the Operations associated with the -// stale updates will not be marked as done until being obsolete. This -// feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this -// feature. +// effect on local inventories. This feature is only available for users +// who have Retail Search enabled. Please enable Retail Search on Cloud +// Console before using this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10460,7 +10443,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall) Do } return ret, nil // { - // "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -10521,13 +10504,9 @@ type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct { // information will be preserved. Pre-existing inventory information can // only be updated with ProductService.SetInventory, // ProductService.AddFulfillmentPlaces, and -// ProductService.RemoveFulfillmentPlaces. The returned Operations will -// be obsolete after 1 day, and GetOperation API will return NOT_FOUND -// afterwards. If conflicting updates are issued, the Operations -// associated with the stale updates will not be marked as done until -// being obsolete. This feature is only available for users who have -// Retail Search enabled. Please enable Retail Search on Cloud Console -// before using this feature. +// ProductService.RemoveFulfillmentPlaces. This feature is only +// available for users who have Retail Search enabled. Please enable +// Retail Search on Cloud Console before using this feature. // // - name: Immutable. Full resource name of the product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10630,7 +10609,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsSetInventoryCall) Do(opts ...g } return ret, nil // { - // "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -12032,10 +12011,10 @@ type ProjectsLocationsCatalogsUserEventsImportCall struct { // Import: Bulk import of User events. Request processing might be // synchronous. Events that already exist are skipped. Use this method -// for backfilling historical user events. `Operation.response` is of -// type `ImportResponse`. Note that it is possible for a subset of the -// items to be successfully inserted. `Operation.metadata` is of type -// `ImportMetadata`. +// for backfilling historical user events. Operation.response is of type +// ImportResponse. Note that it is possible for a subset of the items to +// be successfully inserted. Operation.metadata is of type +// ImportMetadata. // // - parent: `projects/1234/locations/global/catalogs/default_catalog`. func (r *ProjectsLocationsCatalogsUserEventsService) Import(parent string, googlecloudretailv2importusereventsrequest *GoogleCloudRetailV2ImportUserEventsRequest) *ProjectsLocationsCatalogsUserEventsImportCall { @@ -12136,7 +12115,7 @@ func (c *ProjectsLocationsCatalogsUserEventsImportCall) Do(opts ...googleapi.Cal } return ret, nil // { - // "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", + // "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.userEvents.import", diff --git a/retail/v2alpha/retail-api.json b/retail/v2alpha/retail-api.json index 9c90b683b2c..e62736a783d 100644 --- a/retail/v2alpha/retail-api.json +++ b/retail/v2alpha/retail-api.json @@ -561,7 +561,7 @@ "products": { "methods": { "addFulfillmentPlaces": { - "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -589,7 +589,7 @@ ] }, "addLocalInventories": { - "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -847,7 +847,7 @@ ] }, "removeFulfillmentPlaces": { - "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -875,7 +875,7 @@ ] }, "removeLocalInventories": { - "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -903,7 +903,7 @@ ] }, "setInventory": { - "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -1140,7 +1140,7 @@ ], "parameters": { "dryRun": { - "description": "Optional. Whether to run a dry run to validate the request (without actually creating the model).", + "description": "Optional. Whether to run a dry_run to validate the request (without actually creating the model).", "location": "query", "type": "boolean" }, @@ -1173,7 +1173,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}", + "description": "Required. The resource name of the [Model] to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$", "required": true, @@ -1225,7 +1225,7 @@ ] }, "patch": { - "description": "Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them.", + "description": "Update of model metadata. Only fields that currently can be updated are: filtering_option, periodic_tuning_state. If other values are provided, this API method will ignore them.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}", "httpMethod": "PATCH", "id": "retail.projects.locations.catalogs.models.patch", @@ -1234,14 +1234,14 @@ ], "parameters": { "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", + "description": "Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.", + "description": "Optional. Indicates which fields in the provided 'model' to update. If not set, will by default update all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1787,7 +1787,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", + "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.userEvents.import", @@ -2243,14 +2243,14 @@ "id": "GoogleCloudRetailV2ImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2ImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2ImportMetadata", "properties": { "createTime": { @@ -2264,7 +2264,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -3171,11 +3171,11 @@ "type": "object" }, "GoogleCloudRetailV2alphaGcsSource": { - "description": "Google Cloud Storage location for input content.", + "description": "Google Cloud Storage location for input content. format.", "id": "GoogleCloudRetailV2alphaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * `control` (default): One JSON Control per line. Supported values for catalog attribute imports: * `catalog_attribute` (default): One CSV CatalogAttribute per line.", + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * 'control' (default): One JSON Control per line. Supported values for catalog attribute imports: * 'catalog_attribute' (default): One CSV CatalogAttribute per line.", "type": "string" }, "inputUris": { @@ -3238,7 +3238,7 @@ "description": "Required. The desired input location of the data." }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" } }, @@ -3263,14 +3263,14 @@ "id": "GoogleCloudRetailV2alphaImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2alphaImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2alphaImportMetadata", "properties": { "createTime": { @@ -3284,7 +3284,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -3321,7 +3321,7 @@ "description": "Required. The desired input location of the data." }, "notificationPubsubTopic": { - "description": "Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.", + "description": "Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.", "type": "string" }, "reconciliationMode": { @@ -3343,11 +3343,11 @@ "type": "string" }, "skipDefaultBranchProtection": { - "description": "If true, this performs the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.", + "description": "If true, will perform the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to `FULL`.", "type": "boolean" }, "updateMask": { - "description": "Indicates which fields in the provided imported `products` to update. If not set, all fields are updated.", + "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", "format": "google-fieldmask", "type": "string" } @@ -3606,7 +3606,7 @@ "type": "object" }, "GoogleCloudRetailV2alphaModel": { - "description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.", + "description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict api.", "id": "GoogleCloudRetailV2alphaModel", "properties": { "createTime": { @@ -3616,14 +3616,14 @@ "type": "string" }, "dataState": { - "description": "Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.", + "description": "Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.", "enum": [ "DATA_STATE_UNSPECIFIED", "DATA_OK", "DATA_ERROR" ], "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", + "Unspecified default value - should never be explicitly set.", "The model has sufficient training data.", "The model does not have sufficient training data. Error messages can be queried via Stackdriver." ], @@ -3631,11 +3631,11 @@ "type": "string" }, "displayName": { - "description": "Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "description": "Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "filteringOption": { - "description": "Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.", + "description": "Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.", "enum": [ "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED", "RECOMMENDATIONS_FILTERING_DISABLED", @@ -3655,7 +3655,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", + "description": "Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", "type": "string" }, "optimizationObjective": { @@ -3667,7 +3667,7 @@ "description": "Optional. The page optimization config." }, "periodicTuningState": { - "description": "Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.", + "description": "Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED.", "enum": [ "PERIODIC_TUNING_STATE_UNSPECIFIED", "PERIODIC_TUNING_DISABLED", @@ -3675,10 +3675,10 @@ "PERIODIC_TUNING_ENABLED" ], "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", - "The model has periodic tuning disabled. Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or by calling the `TuneModel` method.", - "The model cannot be tuned with periodic tuning OR the `TuneModel` method. Hide the options in customer UI and reject any requests through the backend self serve API.", - "The model has periodic tuning enabled. Tuning can be disabled by calling the `DisableModelPeriodicTuning` method." + "Unspecified default value - should never be explicitly set.", + "The model has periodic tuning disabled. Tuning can be reenabled by calling the EnableModelPeriodicTuning method or by calling the TuneModel method.", + "The model cannot be tuned with periodic tuning OR the TuneModel method. Hide the options in customer UI and reject any requests through the backend self serve API.", + "The model has periodic tuning enabled. Tuning can be disabled by calling the DisableModelPeriodicTuning method." ], "type": "string" }, @@ -3691,7 +3691,7 @@ "type": "array" }, "servingState": { - "description": "Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.", + "description": "Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.", "enum": [ "SERVING_STATE_UNSPECIFIED", "INACTIVE", @@ -3702,13 +3702,13 @@ "Unspecified serving state.", "The model is not serving.", "The model is serving and can be queried.", - "The model is trained on tuned hyperparameters and can be queried." + "The model is trained on tuned hyperparameters, and can be queried." ], "readOnly": true, "type": "string" }, "trainingState": { - "description": "Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.", + "description": "Optional. The training state that the model is in (e.g. TRAINING or PAUSED). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. the default value for UpdateModel method is to keep the state the same as before.", "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", @@ -3727,7 +3727,7 @@ "type": "string" }, "type": { - "description": "Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(readonly value).", + "description": "Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(readonly value).", "type": "string" }, "updateTime": { @@ -3766,9 +3766,9 @@ "enumDescriptions": [ "Unspecified value for restriction.", "Allow any ServingConfig to be show on any number of panels. Example: `Panel1 candidates`: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity `Panel2 candidates`: home_page_ctr_no_diversity, home_page_ctr_diversity, pdp_cvr_no_diversity `Restriction` = NO_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: []", - "Do not allow the same ServingConfig.name to be shown on multiple panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *", - "Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) *", - "Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) *" + "Do not allow the same ServingConfig.name to be shown on multiple panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_SERVING_CONFIG_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *", + "Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) *", + "Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) *" ], "type": "string" } @@ -3780,7 +3780,7 @@ "id": "GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate", "properties": { "servingConfigId": { - "description": "This has to be a valid ServingConfig identifier. For example, for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config`, this would be `my_candidate_config`.", + "description": "This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config` this would be 'my_candidate_config'", "type": "string" } }, @@ -3799,7 +3799,7 @@ }, "defaultCandidate": { "$ref": "GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate", - "description": "Required. The default candidate. If the model fails at serving time, we fall back to the default." + "description": "Required. The default candidate (in case the model fails at serving time, we can fall back to the default)." }, "displayName": { "description": "Optional. The name to display for the panel.", @@ -3809,11 +3809,11 @@ "type": "object" }, "GoogleCloudRetailV2alphaModelServingConfigList": { - "description": "Represents an ordered combination of valid serving configs, which can be used for `PAGE_OPTIMIZATION` recommendations.", + "description": "Represents an ordered combination of valid serving configs, which / may be used for PAGE_OPTIMIZATION recommendations.", "id": "GoogleCloudRetailV2alphaModelServingConfigList", "properties": { "servingConfigIds": { - "description": "Optional. A set of valid serving configs that may be used for `PAGE_OPTIMIZATION`.", + "description": "Optional. A set of valid serving configs that may be used for PAGE_OPTIMIZATION.", "items": { "type": "string" }, @@ -5784,14 +5784,14 @@ "id": "GoogleCloudRetailV2betaImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2betaImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2betaImportMetadata", "properties": { "createTime": { @@ -5805,7 +5805,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { diff --git a/retail/v2alpha/retail-gen.go b/retail/v2alpha/retail-gen.go index 7bf91d811a9..6a790d1682a 100644 --- a/retail/v2alpha/retail-gen.go +++ b/retail/v2alpha/retail-gen.go @@ -683,7 +683,7 @@ func (s *GoogleCloudRetailV2ImportCompletionDataResponse) MarshalJSON() ([]byte, // for Import related errors. type GoogleCloudRetailV2ImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -712,7 +712,7 @@ func (s *GoogleCloudRetailV2ImportErrorsConfig) MarshalJSON() ([]byte, error) { } // GoogleCloudRetailV2ImportMetadata: Metadata related to the progress -// of the Import operation. This is returned by the +// of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2ImportMetadata struct { // CreateTime: Operation create time. @@ -723,9 +723,9 @@ type GoogleCloudRetailV2ImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -2448,7 +2448,7 @@ func (s *GoogleCloudRetailV2alphaFulfillmentInfo) MarshalJSON() ([]byte, error) } // GoogleCloudRetailV2alphaGcsSource: Google Cloud Storage location for -// input content. +// input content. format. type GoogleCloudRetailV2alphaGcsSource struct { // DataSchema: The schema to use when parsing the data from the source. // Supported values for product imports: * `product` (default): One JSON @@ -2459,9 +2459,9 @@ type GoogleCloudRetailV2alphaGcsSource struct { // Supported values for user events imports: * `user_event` (default): // One JSON UserEvent per line. * `user_event_ga360`: Using // https://support.google.com/analytics/answer/3437719. Supported values - // for control imports: * `control` (default): One JSON Control per + // for control imports: * 'control' (default): One JSON Control per // line. Supported values for catalog attribute imports: * - // `catalog_attribute` (default): One CSV CatalogAttribute per line. + // 'catalog_attribute' (default): One CSV CatalogAttribute per line. DataSchema string `json:"dataSchema,omitempty"` // InputUris: Required. Google Cloud Storage URIs to input files. URI @@ -2588,9 +2588,9 @@ type GoogleCloudRetailV2alphaImportCompletionDataRequest struct { InputConfig *GoogleCloudRetailV2alphaCompletionDataInputConfig `json:"inputConfig,omitempty"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -2654,7 +2654,7 @@ func (s *GoogleCloudRetailV2alphaImportCompletionDataResponse) MarshalJSON() ([] // destination for Import related errors. type GoogleCloudRetailV2alphaImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -2683,7 +2683,7 @@ func (s *GoogleCloudRetailV2alphaImportErrorsConfig) MarshalJSON() ([]byte, erro } // GoogleCloudRetailV2alphaImportMetadata: Metadata related to the -// progress of the Import operation. This is returned by the +// progress of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2alphaImportMetadata struct { // CreateTime: Operation create time. @@ -2694,9 +2694,9 @@ type GoogleCloudRetailV2alphaImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -2749,9 +2749,9 @@ type GoogleCloudRetailV2alphaImportProductsRequest struct { // NotificationPubsubTopic: Full Pub/Sub topic name for receiving // notification. If this field is set, when the import is finished, a - // notification is sent to specified Pub/Sub topic. The message data is - // JSON string of a Operation. Format of the Pub/Sub topic is - // `projects/{project}/topics/{topic}`. It has to be within the same + // notification will be sent to specified Pub/Sub topic. The message + // data will be JSON string of a Operation. Format of the Pub/Sub topic + // is `projects/{project}/topics/{topic}`. It has to be within the same // project as ImportProductsRequest.parent. Make sure that // `service-@gcp-sa-retail.iam.gserviceaccount.com` has the // `pubsub.topics.publish` IAM permission on the topic. @@ -2772,7 +2772,7 @@ type GoogleCloudRetailV2alphaImportProductsRequest struct { // RequestId: Deprecated. This field has no effect. RequestId string `json:"requestId,omitempty"` - // SkipDefaultBranchProtection: If true, this performs the FULL import + // SkipDefaultBranchProtection: If true, will perform the FULL import // even if it would delete a large proportion of the products in the // default branch, which could potentially cause outages if you have // live predict/search traffic. Only supported when @@ -2780,7 +2780,7 @@ type GoogleCloudRetailV2alphaImportProductsRequest struct { SkipDefaultBranchProtection bool `json:"skipDefaultBranchProtection,omitempty"` // UpdateMask: Indicates which fields in the provided imported - // `products` to update. If not set, all fields are updated. + // 'products' to update. If not set, will by default update all fields. UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorsConfig") to @@ -3325,21 +3325,21 @@ func (s *GoogleCloudRetailV2alphaMerchantCenterLinkingConfig) MarshalJSON() ([]b // GoogleCloudRetailV2alphaModel: Metadata that describes the training // and serving parameters of a Model. A Model can be associated with a -// ServingConfig and then queried through the Predict API. +// ServingConfig and then queried through the Predict api. type GoogleCloudRetailV2alphaModel struct { // CreateTime: Output only. Timestamp the Recommendation Model was // created at. CreateTime string `json:"createTime,omitempty"` // DataState: Output only. The state of data requirements for this - // model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be - // trained if the data is in `DATA_ERROR` state. Recommendation model - // can have `DATA_ERROR` state even if serving state is `ACTIVE`: models - // were trained successfully before, but cannot be refreshed because - // model no longer has sufficient data for training. + // model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained + // if the data is in DATA_ERROR state. Recommendation model can have + // DATA_ERROR state even if serving state is ACTIVE: models were trained + // successfully before, but cannot be refreshed because model no longer + // has sufficient data for training. // // Possible values: - // "DATA_STATE_UNSPECIFIED" - Unspecified default value, should never + // "DATA_STATE_UNSPECIFIED" - Unspecified default value - should never // be explicitly set. // "DATA_OK" - The model has sufficient training data. // "DATA_ERROR" - The model does not have sufficient training data. @@ -3348,11 +3348,10 @@ type GoogleCloudRetailV2alphaModel struct { // DisplayName: Required. The display name of the model. Should be human // readable, used to display Recommendation Models in the Retail Cloud - // Console Dashboard. UTF-8 encoded string with limit of 1024 - // characters. + // Cosole Dashboard. UTF-8 encoded string with limit of 1024 characters. DisplayName string `json:"displayName,omitempty"` - // FilteringOption: Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, + // FilteringOption: Optional. If RECOMMENDATIONS_FILTERING_ENABLED, // recommendation filtering by attributes is enabled for the model. // // Possible values: @@ -3371,8 +3370,8 @@ type GoogleCloudRetailV2alphaModel struct { // Name: Required. The fully qualified resource name of the model. // Format: - // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_i - // d}/models/{model_id}` catalog_id has char limit of 50. + // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id + // }/models/{model_id} catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. Name string `json:"name,omitempty"` @@ -3389,20 +3388,19 @@ type GoogleCloudRetailV2alphaModel struct { // PeriodicTuningState: Optional. The state of periodic tuning. The // period we use is 3 months - to do a one-off tune earlier use the - // `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. + // TuneModel method. Default value is PERIODIC_TUNING_ENABLED. // // Possible values: - // "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value, + // "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value - // should never be explicitly set. // "PERIODIC_TUNING_DISABLED" - The model has periodic tuning // disabled. Tuning can be reenabled by calling the - // `EnableModelPeriodicTuning` method or by calling the `TuneModel` - // method. + // EnableModelPeriodicTuning method or by calling the TuneModel method. // "ALL_TUNING_DISABLED" - The model cannot be tuned with periodic - // tuning OR the `TuneModel` method. Hide the options in customer UI and + // tuning OR the TuneModel method. Hide the options in customer UI and // reject any requests through the backend self serve API. // "PERIODIC_TUNING_ENABLED" - The model has periodic tuning enabled. - // Tuning can be disabled by calling the `DisableModelPeriodicTuning` + // Tuning can be disabled by calling the DisableModelPeriodicTuning // method. PeriodicTuningState string `json:"periodicTuningState,omitempty"` @@ -3410,24 +3408,23 @@ type GoogleCloudRetailV2alphaModel struct { // associated with the PageOptimizationConfig. ServingConfigLists []*GoogleCloudRetailV2alphaModelServingConfigList `json:"servingConfigLists,omitempty"` - // ServingState: Output only. The serving state of the model: `ACTIVE`, - // `NOT_ACTIVE`. + // ServingState: Output only. The serving state of the model: ACTIVE, + // NOT_ACTIVE. // // Possible values: // "SERVING_STATE_UNSPECIFIED" - Unspecified serving state. // "INACTIVE" - The model is not serving. // "ACTIVE" - The model is serving and can be queried. - // "TUNED" - The model is trained on tuned hyperparameters and can be + // "TUNED" - The model is trained on tuned hyperparameters, and can be // queried. ServingState string `json:"servingState,omitempty"` // TrainingState: Optional. The training state that the model is in - // (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the + // (e.g. TRAINING or PAUSED). Since part of the cost of running the // service is frequency of training - this can be used to determine when // to train model in order to control cost. If not specified: the - // default value for `CreateModel` method is `TRAINING`. The default - // value for `UpdateModel` method is to keep the state the same as - // before. + // default value for CreateModel method is TRAINING. the default value + // for UpdateModel method is to keep the state the same as before. // // Possible values: // "TRAINING_STATE_UNSPECIFIED" - Unspecified training state. @@ -3442,8 +3439,8 @@ type GoogleCloudRetailV2alphaModel struct { // Type: Required. The type of model e.g. `home-page`. Currently // supported values: `recommended-for-you`, `others-you-may-like`, - // `frequently-bought-together`, `page-optimization`, `similar-items`, - // `buy-it-again`, and `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, 'similar-items', + // 'buy-it-again', `recently-viewed`(readonly value). Type string `json:"type,omitempty"` // UpdateTime: Output only. Timestamp the Recommendation Model was last @@ -3524,21 +3521,21 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct { // candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 // candidates`: * home_page_ctr_no_diversity, // home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = - // `UNIQUE_SERVING_CONFIG_RESTRICTION` `Valid combinations`: * * - // (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, - // home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * - // (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, - // home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) - // * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, - // home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, - // pdp_cvr_no_diversity) * `Invalid combinations`: * * - // (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * + // UNIQUE_SERVING_CONFIG_RESTRICTION `Valid combinations`: * * (pdp_ctr, + // home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) + // * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * + // (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, + // home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * + // (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * + // (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid + // combinations`: * * (home_page_ctr_no_diversity, + // home_page_ctr_no_diversity) * // "UNIQUE_MODEL_RESTRICTION" - Do not allow multiple ServingConfigs // with same Model.name to be show on on different panels. Example: // `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * // `Panel2 candidates`: * home_page_ctr_no_diversity, // home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = - // `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, + // UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, // home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * // (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * // (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, @@ -3551,7 +3548,7 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct { // Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, // home_page_ctr_no_diversity * `Panel2 candidates`: * // home_page_ctr_no_diversity, home_page_ctr_diversity_low, - // pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` + // pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION // `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * // (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, // home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) @@ -3591,10 +3588,10 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfig) MarshalJSON() ([]b // candidate to consider for a given panel. Currently only ServingConfig // are valid candidates. type GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate struct { - // ServingConfigId: This has to be a valid ServingConfig identifier. For - // example, for a ServingConfig with full name: + // ServingConfigId: This has to be a valid ServingConfig identifier. + // e.g. for a ServingConfig with full name: // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/m - // y_candidate_config`, this would be `my_candidate_config`. + // y_candidate_config` this would be 'my_candidate_config' ServingConfigId string `json:"servingConfigId,omitempty"` // ForceSendFields is a list of field names (e.g. "ServingConfigId") to @@ -3628,8 +3625,8 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct { // = 10. Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"` - // DefaultCandidate: Required. The default candidate. If the model fails - // at serving time, we fall back to the default. + // DefaultCandidate: Required. The default candidate (in case the model + // fails at serving time, we can fall back to the default). DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"` // DisplayName: Optional. The name to display for the panel. @@ -3659,11 +3656,11 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel) MarshalJSON() } // GoogleCloudRetailV2alphaModelServingConfigList: Represents an ordered -// combination of valid serving configs, which can be used for -// `PAGE_OPTIMIZATION` recommendations. +// combination of valid serving configs, which / may be used for +// PAGE_OPTIMIZATION recommendations. type GoogleCloudRetailV2alphaModelServingConfigList struct { // ServingConfigIds: Optional. A set of valid serving configs that may - // be used for `PAGE_OPTIMIZATION`. + // be used for PAGE_OPTIMIZATION. ServingConfigIds []string `json:"servingConfigIds,omitempty"` // ForceSendFields is a list of field names (e.g. "ServingConfigIds") to @@ -7559,7 +7556,7 @@ func (s *GoogleCloudRetailV2betaImportCompletionDataResponse) MarshalJSON() ([]b // destination for Import related errors. type GoogleCloudRetailV2betaImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -7588,7 +7585,7 @@ func (s *GoogleCloudRetailV2betaImportErrorsConfig) MarshalJSON() ([]byte, error } // GoogleCloudRetailV2betaImportMetadata: Metadata related to the -// progress of the Import operation. This is returned by the +// progress of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2betaImportMetadata struct { // CreateTime: Operation create time. @@ -7599,9 +7596,9 @@ type GoogleCloudRetailV2betaImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -10415,12 +10412,9 @@ type ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall struct { // processed downstream. As a consequence, when a response is returned, // the added place IDs are not immediately manifested in the Product // queried by ProductService.GetProduct or ProductService.ListProducts. -// The returned Operations will be obsolete after 1 day, and -// GetOperation API will return NOT_FOUND afterwards. If conflicting -// updates are issued, the Operations associated with the stale updates -// will not be marked as done until being obsolete. This feature is only -// available for users who have Retail Search enabled. Please enable -// Retail Search on Cloud Console before using this feature. +// This feature is only available for users who have Retail Search +// enabled. Please enable Retail Search on Cloud Console before using +// this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10525,7 +10519,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall) Do(o } return ret, nil // { - // "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -10576,13 +10570,9 @@ type ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall struct { // ProductService.GetProduct or ProductService.ListProducts. Local // inventory information can only be modified using this method. // ProductService.CreateProduct and ProductService.UpdateProduct has no -// effect on local inventories. The returned Operations will be obsolete -// after 1 day, and GetOperation API will return NOT_FOUND afterwards. -// If conflicting updates are issued, the Operations associated with the -// stale updates will not be marked as done until being obsolete. This -// feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this -// feature. +// effect on local inventories. This feature is only available for users +// who have Retail Search enabled. Please enable Retail Search on Cloud +// Console before using this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10687,7 +10677,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall) Do(op } return ret, nil // { - // "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -11927,12 +11917,9 @@ type ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall struct // processed downstream. As a consequence, when a response is returned, // the removed place IDs are not immediately manifested in the Product // queried by ProductService.GetProduct or ProductService.ListProducts. -// The returned Operations will be obsolete after 1 day, and -// GetOperation API will return NOT_FOUND afterwards. If conflicting -// updates are issued, the Operations associated with the stale updates -// will not be marked as done until being obsolete. This feature is only -// available for users who have Retail Search enabled. Please enable -// Retail Search on Cloud Console before using this feature. +// This feature is only available for users who have Retail Search +// enabled. Please enable Retail Search on Cloud Console before using +// this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12037,7 +12024,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall) D } return ret, nil // { - // "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -12086,13 +12073,9 @@ type ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall struct // queried by ProductService.GetProduct or ProductService.ListProducts. // Local inventory information can only be removed using this method. // ProductService.CreateProduct and ProductService.UpdateProduct has no -// effect on local inventories. The returned Operations will be obsolete -// after 1 day, and GetOperation API will return NOT_FOUND afterwards. -// If conflicting updates are issued, the Operations associated with the -// stale updates will not be marked as done until being obsolete. This -// feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this -// feature. +// effect on local inventories. This feature is only available for users +// who have Retail Search enabled. Please enable Retail Search on Cloud +// Console before using this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12197,7 +12180,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall) Do } return ret, nil // { - // "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -12258,13 +12241,9 @@ type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct { // information will be preserved. Pre-existing inventory information can // only be updated with ProductService.SetInventory, // ProductService.AddFulfillmentPlaces, and -// ProductService.RemoveFulfillmentPlaces. The returned Operations will -// be obsolete after 1 day, and GetOperation API will return NOT_FOUND -// afterwards. If conflicting updates are issued, the Operations -// associated with the stale updates will not be marked as done until -// being obsolete. This feature is only available for users who have -// Retail Search enabled. Please enable Retail Search on Cloud Console -// before using this feature. +// ProductService.RemoveFulfillmentPlaces. This feature is only +// available for users who have Retail Search enabled. Please enable +// Retail Search on Cloud Console before using this feature. // // - name: Immutable. Full resource name of the product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12367,7 +12346,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsSetInventoryCall) Do(opts ...g } return ret, nil // { - // "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -13384,7 +13363,7 @@ func (r *ProjectsLocationsCatalogsModelsService) Create(parent string, googleclo return c } -// DryRun sets the optional parameter "dryRun": Whether to run a dry run +// DryRun sets the optional parameter "dryRun": Whether to run a dry_run // to validate the request (without actually creating the model). func (c *ProjectsLocationsCatalogsModelsCreateCall) DryRun(dryRun bool) *ProjectsLocationsCatalogsModelsCreateCall { c.urlParams_.Set("dryRun", fmt.Sprint(dryRun)) @@ -13491,7 +13470,7 @@ func (c *ProjectsLocationsCatalogsModelsCreateCall) Do(opts ...googleapi.CallOpt // ], // "parameters": { // "dryRun": { - // "description": "Optional. Whether to run a dry run to validate the request (without actually creating the model).", + // "description": "Optional. Whether to run a dry_run to validate the request (without actually creating the model).", // "location": "query", // "type": "boolean" // }, @@ -13529,7 +13508,7 @@ type ProjectsLocationsCatalogsModelsDeleteCall struct { // Delete: Deletes an existing model. // -// - name: The resource name of the Model to delete. Format: +// - name: The resource name of the [Model] to delete. Format: // projects/{project_number}/locations/{location_id}/catalogs/{catalog_ // id}/models/{model_id}. func (r *ProjectsLocationsCatalogsModelsService) Delete(name string) *ProjectsLocationsCatalogsModelsDeleteCall { @@ -13633,7 +13612,7 @@ func (c *ProjectsLocationsCatalogsModelsDeleteCall) Do(opts ...googleapi.CallOpt // ], // "parameters": { // "name": { - // "description": "Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}", + // "description": "Required. The resource name of the [Model] to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$", // "required": true, @@ -13861,12 +13840,12 @@ type ProjectsLocationsCatalogsModelsPatchCall struct { } // Patch: Update of model metadata. Only fields that currently can be -// updated are: `filtering_option` and `periodic_tuning_state`. If other -// values are provided, this API method ignores them. +// updated are: filtering_option, periodic_tuning_state. If other values +// are provided, this API method will ignore them. // // - name: The fully qualified resource name of the model. Format: -// `projects/{project_number}/locations/{location_id}/catalogs/{catalog -// _id}/models/{model_id}` catalog_id has char limit of 50. +// projects/{project_number}/locations/{location_id}/catalogs/{catalog_ +// id}/models/{model_id} catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. func (r *ProjectsLocationsCatalogsModelsService) Patch(name string, googlecloudretailv2alphamodel *GoogleCloudRetailV2alphaModel) *ProjectsLocationsCatalogsModelsPatchCall { c := &ProjectsLocationsCatalogsModelsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -13876,8 +13855,8 @@ func (r *ProjectsLocationsCatalogsModelsService) Patch(name string, googlecloudr } // UpdateMask sets the optional parameter "updateMask": Indicates which -// fields in the provided 'model' to update. If not set, by default -// updates all fields. +// fields in the provided 'model' to update. If not set, will by default +// update all fields. func (c *ProjectsLocationsCatalogsModelsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsCatalogsModelsPatchCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -13974,7 +13953,7 @@ func (c *ProjectsLocationsCatalogsModelsPatchCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them.", + // "description": "Update of model metadata. Only fields that currently can be updated are: filtering_option, periodic_tuning_state. If other values are provided, this API method will ignore them.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}", // "httpMethod": "PATCH", // "id": "retail.projects.locations.catalogs.models.patch", @@ -13983,14 +13962,14 @@ func (c *ProjectsLocationsCatalogsModelsPatchCall) Do(opts ...googleapi.CallOpti // ], // "parameters": { // "name": { - // "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", + // "description": "Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$", // "required": true, // "type": "string" // }, // "updateMask": { - // "description": "Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.", + // "description": "Optional. Indicates which fields in the provided 'model' to update. If not set, will by default update all fields.", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -16766,10 +16745,10 @@ type ProjectsLocationsCatalogsUserEventsImportCall struct { // Import: Bulk import of User events. Request processing might be // synchronous. Events that already exist are skipped. Use this method -// for backfilling historical user events. `Operation.response` is of -// type `ImportResponse`. Note that it is possible for a subset of the -// items to be successfully inserted. `Operation.metadata` is of type -// `ImportMetadata`. +// for backfilling historical user events. Operation.response is of type +// ImportResponse. Note that it is possible for a subset of the items to +// be successfully inserted. Operation.metadata is of type +// ImportMetadata. // // - parent: `projects/1234/locations/global/catalogs/default_catalog`. func (r *ProjectsLocationsCatalogsUserEventsService) Import(parent string, googlecloudretailv2alphaimportusereventsrequest *GoogleCloudRetailV2alphaImportUserEventsRequest) *ProjectsLocationsCatalogsUserEventsImportCall { @@ -16870,7 +16849,7 @@ func (c *ProjectsLocationsCatalogsUserEventsImportCall) Do(opts ...googleapi.Cal } return ret, nil // { - // "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", + // "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.userEvents.import", diff --git a/retail/v2beta/retail-api.json b/retail/v2beta/retail-api.json index 94fd3424619..887dba5742e 100644 --- a/retail/v2beta/retail-api.json +++ b/retail/v2beta/retail-api.json @@ -561,7 +561,7 @@ "products": { "methods": { "addFulfillmentPlaces": { - "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -589,7 +589,7 @@ ] }, "addLocalInventories": { - "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -814,7 +814,7 @@ ] }, "removeFulfillmentPlaces": { - "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -842,7 +842,7 @@ ] }, "removeLocalInventories": { - "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -870,7 +870,7 @@ ] }, "setInventory": { - "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -1538,7 +1538,7 @@ ] }, "import": { - "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", + "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", "httpMethod": "POST", "id": "retail.projects.locations.catalogs.userEvents.import", @@ -1994,14 +1994,14 @@ "id": "GoogleCloudRetailV2ImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2ImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2ImportMetadata", "properties": { "createTime": { @@ -2015,7 +2015,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -2305,14 +2305,14 @@ "id": "GoogleCloudRetailV2alphaImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2alphaImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2alphaImportMetadata", "properties": { "createTime": { @@ -2326,7 +2326,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -2391,7 +2391,7 @@ "type": "object" }, "GoogleCloudRetailV2alphaModel": { - "description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.", + "description": "Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict api.", "id": "GoogleCloudRetailV2alphaModel", "properties": { "createTime": { @@ -2401,14 +2401,14 @@ "type": "string" }, "dataState": { - "description": "Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.", + "description": "Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.", "enum": [ "DATA_STATE_UNSPECIFIED", "DATA_OK", "DATA_ERROR" ], "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", + "Unspecified default value - should never be explicitly set.", "The model has sufficient training data.", "The model does not have sufficient training data. Error messages can be queried via Stackdriver." ], @@ -2416,11 +2416,11 @@ "type": "string" }, "displayName": { - "description": "Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.", + "description": "Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, "filteringOption": { - "description": "Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.", + "description": "Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.", "enum": [ "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED", "RECOMMENDATIONS_FILTERING_DISABLED", @@ -2440,7 +2440,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", + "description": "Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.", "type": "string" }, "optimizationObjective": { @@ -2452,7 +2452,7 @@ "description": "Optional. The page optimization config." }, "periodicTuningState": { - "description": "Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.", + "description": "Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED.", "enum": [ "PERIODIC_TUNING_STATE_UNSPECIFIED", "PERIODIC_TUNING_DISABLED", @@ -2460,10 +2460,10 @@ "PERIODIC_TUNING_ENABLED" ], "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", - "The model has periodic tuning disabled. Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or by calling the `TuneModel` method.", - "The model cannot be tuned with periodic tuning OR the `TuneModel` method. Hide the options in customer UI and reject any requests through the backend self serve API.", - "The model has periodic tuning enabled. Tuning can be disabled by calling the `DisableModelPeriodicTuning` method." + "Unspecified default value - should never be explicitly set.", + "The model has periodic tuning disabled. Tuning can be reenabled by calling the EnableModelPeriodicTuning method or by calling the TuneModel method.", + "The model cannot be tuned with periodic tuning OR the TuneModel method. Hide the options in customer UI and reject any requests through the backend self serve API.", + "The model has periodic tuning enabled. Tuning can be disabled by calling the DisableModelPeriodicTuning method." ], "type": "string" }, @@ -2476,7 +2476,7 @@ "type": "array" }, "servingState": { - "description": "Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.", + "description": "Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.", "enum": [ "SERVING_STATE_UNSPECIFIED", "INACTIVE", @@ -2487,13 +2487,13 @@ "Unspecified serving state.", "The model is not serving.", "The model is serving and can be queried.", - "The model is trained on tuned hyperparameters and can be queried." + "The model is trained on tuned hyperparameters, and can be queried." ], "readOnly": true, "type": "string" }, "trainingState": { - "description": "Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.", + "description": "Optional. The training state that the model is in (e.g. TRAINING or PAUSED). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. the default value for UpdateModel method is to keep the state the same as before.", "enum": [ "TRAINING_STATE_UNSPECIFIED", "PAUSED", @@ -2512,7 +2512,7 @@ "type": "string" }, "type": { - "description": "Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(readonly value).", + "description": "Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, 'similar-items', 'buy-it-again', `recently-viewed`(readonly value).", "type": "string" }, "updateTime": { @@ -2551,9 +2551,9 @@ "enumDescriptions": [ "Unspecified value for restriction.", "Allow any ServingConfig to be show on any number of panels. Example: `Panel1 candidates`: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity `Panel2 candidates`: home_page_ctr_no_diversity, home_page_ctr_diversity, pdp_cvr_no_diversity `Restriction` = NO_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: []", - "Do not allow the same ServingConfig.name to be shown on multiple panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *", - "Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) *", - "Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) *" + "Do not allow the same ServingConfig.name to be shown on multiple panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_SERVING_CONFIG_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *", + "Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) *", + "Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (home_page_ctr_no_diversity, home_page_ctr_diversity) *" ], "type": "string" } @@ -2565,7 +2565,7 @@ "id": "GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate", "properties": { "servingConfigId": { - "description": "This has to be a valid ServingConfig identifier. For example, for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config`, this would be `my_candidate_config`.", + "description": "This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config` this would be 'my_candidate_config'", "type": "string" } }, @@ -2584,7 +2584,7 @@ }, "defaultCandidate": { "$ref": "GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate", - "description": "Required. The default candidate. If the model fails at serving time, we fall back to the default." + "description": "Required. The default candidate (in case the model fails at serving time, we can fall back to the default)." }, "displayName": { "description": "Optional. The name to display for the panel.", @@ -2594,11 +2594,11 @@ "type": "object" }, "GoogleCloudRetailV2alphaModelServingConfigList": { - "description": "Represents an ordered combination of valid serving configs, which can be used for `PAGE_OPTIMIZATION` recommendations.", + "description": "Represents an ordered combination of valid serving configs, which / may be used for PAGE_OPTIMIZATION recommendations.", "id": "GoogleCloudRetailV2alphaModelServingConfigList", "properties": { "servingConfigIds": { - "description": "Optional. A set of valid serving configs that may be used for `PAGE_OPTIMIZATION`.", + "description": "Optional. A set of valid serving configs that may be used for PAGE_OPTIMIZATION.", "items": { "type": "string" }, @@ -3537,11 +3537,11 @@ "type": "object" }, "GoogleCloudRetailV2betaGcsSource": { - "description": "Google Cloud Storage location for input content.", + "description": "Google Cloud Storage location for input content. format.", "id": "GoogleCloudRetailV2betaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * `control` (default): One JSON Control per line. Supported values for catalog attribute imports: * `catalog_attribute` (default): One CSV CatalogAttribute per line.", + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * 'control' (default): One JSON Control per line. Supported values for catalog attribute imports: * 'catalog_attribute' (default): One CSV CatalogAttribute per line.", "type": "string" }, "inputUris": { @@ -3604,7 +3604,7 @@ "description": "Required. The desired input location of the data." }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" } }, @@ -3629,14 +3629,14 @@ "id": "GoogleCloudRetailV2betaImportErrorsConfig", "properties": { "gcsPrefix": { - "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudRetailV2betaImportMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2betaImportMetadata", "properties": { "createTime": { @@ -3650,7 +3650,7 @@ "type": "string" }, "notificationPubsubTopic": { - "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", + "description": "Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.", "type": "string" }, "requestId": { @@ -3683,7 +3683,7 @@ "description": "Required. The desired input location of the data." }, "notificationPubsubTopic": { - "description": "Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.", + "description": "Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.", "type": "string" }, "reconciliationMode": { @@ -3705,7 +3705,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported `products` to update. If not set, all fields are updated.", + "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", "format": "google-fieldmask", "type": "string" } diff --git a/retail/v2beta/retail-gen.go b/retail/v2beta/retail-gen.go index 9169317a0a6..b6aa09deb17 100644 --- a/retail/v2beta/retail-gen.go +++ b/retail/v2beta/retail-gen.go @@ -671,7 +671,7 @@ func (s *GoogleCloudRetailV2ImportCompletionDataResponse) MarshalJSON() ([]byte, // for Import related errors. type GoogleCloudRetailV2ImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -700,7 +700,7 @@ func (s *GoogleCloudRetailV2ImportErrorsConfig) MarshalJSON() ([]byte, error) { } // GoogleCloudRetailV2ImportMetadata: Metadata related to the progress -// of the Import operation. This is returned by the +// of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2ImportMetadata struct { // CreateTime: Operation create time. @@ -711,9 +711,9 @@ type GoogleCloudRetailV2ImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -1255,7 +1255,7 @@ func (s *GoogleCloudRetailV2alphaImportCompletionDataResponse) MarshalJSON() ([] // destination for Import related errors. type GoogleCloudRetailV2alphaImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -1284,7 +1284,7 @@ func (s *GoogleCloudRetailV2alphaImportErrorsConfig) MarshalJSON() ([]byte, erro } // GoogleCloudRetailV2alphaImportMetadata: Metadata related to the -// progress of the Import operation. This is returned by the +// progress of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2alphaImportMetadata struct { // CreateTime: Operation create time. @@ -1295,9 +1295,9 @@ type GoogleCloudRetailV2alphaImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -1417,21 +1417,21 @@ func (s *GoogleCloudRetailV2alphaImportUserEventsResponse) MarshalJSON() ([]byte // GoogleCloudRetailV2alphaModel: Metadata that describes the training // and serving parameters of a Model. A Model can be associated with a -// ServingConfig and then queried through the Predict API. +// ServingConfig and then queried through the Predict api. type GoogleCloudRetailV2alphaModel struct { // CreateTime: Output only. Timestamp the Recommendation Model was // created at. CreateTime string `json:"createTime,omitempty"` // DataState: Output only. The state of data requirements for this - // model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be - // trained if the data is in `DATA_ERROR` state. Recommendation model - // can have `DATA_ERROR` state even if serving state is `ACTIVE`: models - // were trained successfully before, but cannot be refreshed because - // model no longer has sufficient data for training. + // model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained + // if the data is in DATA_ERROR state. Recommendation model can have + // DATA_ERROR state even if serving state is ACTIVE: models were trained + // successfully before, but cannot be refreshed because model no longer + // has sufficient data for training. // // Possible values: - // "DATA_STATE_UNSPECIFIED" - Unspecified default value, should never + // "DATA_STATE_UNSPECIFIED" - Unspecified default value - should never // be explicitly set. // "DATA_OK" - The model has sufficient training data. // "DATA_ERROR" - The model does not have sufficient training data. @@ -1440,11 +1440,10 @@ type GoogleCloudRetailV2alphaModel struct { // DisplayName: Required. The display name of the model. Should be human // readable, used to display Recommendation Models in the Retail Cloud - // Console Dashboard. UTF-8 encoded string with limit of 1024 - // characters. + // Cosole Dashboard. UTF-8 encoded string with limit of 1024 characters. DisplayName string `json:"displayName,omitempty"` - // FilteringOption: Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, + // FilteringOption: Optional. If RECOMMENDATIONS_FILTERING_ENABLED, // recommendation filtering by attributes is enabled for the model. // // Possible values: @@ -1463,8 +1462,8 @@ type GoogleCloudRetailV2alphaModel struct { // Name: Required. The fully qualified resource name of the model. // Format: - // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_i - // d}/models/{model_id}` catalog_id has char limit of 50. + // projects/{project_number}/locations/{location_id}/catalogs/{catalog_id + // }/models/{model_id} catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. Name string `json:"name,omitempty"` @@ -1481,20 +1480,19 @@ type GoogleCloudRetailV2alphaModel struct { // PeriodicTuningState: Optional. The state of periodic tuning. The // period we use is 3 months - to do a one-off tune earlier use the - // `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. + // TuneModel method. Default value is PERIODIC_TUNING_ENABLED. // // Possible values: - // "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value, + // "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value - // should never be explicitly set. // "PERIODIC_TUNING_DISABLED" - The model has periodic tuning // disabled. Tuning can be reenabled by calling the - // `EnableModelPeriodicTuning` method or by calling the `TuneModel` - // method. + // EnableModelPeriodicTuning method or by calling the TuneModel method. // "ALL_TUNING_DISABLED" - The model cannot be tuned with periodic - // tuning OR the `TuneModel` method. Hide the options in customer UI and + // tuning OR the TuneModel method. Hide the options in customer UI and // reject any requests through the backend self serve API. // "PERIODIC_TUNING_ENABLED" - The model has periodic tuning enabled. - // Tuning can be disabled by calling the `DisableModelPeriodicTuning` + // Tuning can be disabled by calling the DisableModelPeriodicTuning // method. PeriodicTuningState string `json:"periodicTuningState,omitempty"` @@ -1502,24 +1500,23 @@ type GoogleCloudRetailV2alphaModel struct { // associated with the PageOptimizationConfig. ServingConfigLists []*GoogleCloudRetailV2alphaModelServingConfigList `json:"servingConfigLists,omitempty"` - // ServingState: Output only. The serving state of the model: `ACTIVE`, - // `NOT_ACTIVE`. + // ServingState: Output only. The serving state of the model: ACTIVE, + // NOT_ACTIVE. // // Possible values: // "SERVING_STATE_UNSPECIFIED" - Unspecified serving state. // "INACTIVE" - The model is not serving. // "ACTIVE" - The model is serving and can be queried. - // "TUNED" - The model is trained on tuned hyperparameters and can be + // "TUNED" - The model is trained on tuned hyperparameters, and can be // queried. ServingState string `json:"servingState,omitempty"` // TrainingState: Optional. The training state that the model is in - // (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the + // (e.g. TRAINING or PAUSED). Since part of the cost of running the // service is frequency of training - this can be used to determine when // to train model in order to control cost. If not specified: the - // default value for `CreateModel` method is `TRAINING`. The default - // value for `UpdateModel` method is to keep the state the same as - // before. + // default value for CreateModel method is TRAINING. the default value + // for UpdateModel method is to keep the state the same as before. // // Possible values: // "TRAINING_STATE_UNSPECIFIED" - Unspecified training state. @@ -1534,8 +1531,8 @@ type GoogleCloudRetailV2alphaModel struct { // Type: Required. The type of model e.g. `home-page`. Currently // supported values: `recommended-for-you`, `others-you-may-like`, - // `frequently-bought-together`, `page-optimization`, `similar-items`, - // `buy-it-again`, and `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, 'similar-items', + // 'buy-it-again', `recently-viewed`(readonly value). Type string `json:"type,omitempty"` // UpdateTime: Output only. Timestamp the Recommendation Model was last @@ -1612,21 +1609,21 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct { // candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2 // candidates`: * home_page_ctr_no_diversity, // home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = - // `UNIQUE_SERVING_CONFIG_RESTRICTION` `Valid combinations`: * * - // (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr, - // home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * - // (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr, - // home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) - // * (pdp_cvr, pdp_cvr_no_diversity) * (home_page_ctr_no_diversity, - // home_page_ctr_diversity_low) * (home_page_ctr_no_diversity, - // pdp_cvr_no_diversity) * `Invalid combinations`: * * - // (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * + // UNIQUE_SERVING_CONFIG_RESTRICTION `Valid combinations`: * * (pdp_ctr, + // home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity_low) + // * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * + // (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, + // home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) * + // (home_page_ctr_no_diversity, home_page_ctr_diversity_low) * + // (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid + // combinations`: * * (home_page_ctr_no_diversity, + // home_page_ctr_no_diversity) * // "UNIQUE_MODEL_RESTRICTION" - Do not allow multiple ServingConfigs // with same Model.name to be show on on different panels. Example: // `Panel1 candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * // `Panel2 candidates`: * home_page_ctr_no_diversity, // home_page_ctr_diversity_low, pdp_cvr_no_diversity * `Restriction` = - // `UNIQUE_MODEL_RESTRICTION` `Valid combinations`: * * (pdp_ctr, + // UNIQUE_MODEL_RESTRICTION `Valid combinations`: * * (pdp_ctr, // home_page_ctr_no_diversity) * (pdp_ctr, home_page_ctr_diversity) * // (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * // (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr, @@ -1639,7 +1636,7 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct { // Example: `Panel1 candidates`: * pdp_ctr, pdp_cvr, // home_page_ctr_no_diversity * `Panel2 candidates`: * // home_page_ctr_no_diversity, home_page_ctr_diversity_low, - // pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` + // pdp_cvr_no_diversity * `Restriction` = UNIQUE_MODEL_RESTRICTION // `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * // (pdp_ctr, home_page_ctr_diversity) * (pdp_cvr, // home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity_low) @@ -1679,10 +1676,10 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfig) MarshalJSON() ([]b // candidate to consider for a given panel. Currently only ServingConfig // are valid candidates. type GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate struct { - // ServingConfigId: This has to be a valid ServingConfig identifier. For - // example, for a ServingConfig with full name: + // ServingConfigId: This has to be a valid ServingConfig identifier. + // e.g. for a ServingConfig with full name: // `projects/*/locations/global/catalogs/default_catalog/servingConfigs/m - // y_candidate_config`, this would be `my_candidate_config`. + // y_candidate_config` this would be 'my_candidate_config' ServingConfigId string `json:"servingConfigId,omitempty"` // ForceSendFields is a list of field names (e.g. "ServingConfigId") to @@ -1716,8 +1713,8 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct { // = 10. Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"` - // DefaultCandidate: Required. The default candidate. If the model fails - // at serving time, we fall back to the default. + // DefaultCandidate: Required. The default candidate (in case the model + // fails at serving time, we can fall back to the default). DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"` // DisplayName: Optional. The name to display for the panel. @@ -1747,11 +1744,11 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel) MarshalJSON() } // GoogleCloudRetailV2alphaModelServingConfigList: Represents an ordered -// combination of valid serving configs, which can be used for -// `PAGE_OPTIMIZATION` recommendations. +// combination of valid serving configs, which / may be used for +// PAGE_OPTIMIZATION recommendations. type GoogleCloudRetailV2alphaModelServingConfigList struct { // ServingConfigIds: Optional. A set of valid serving configs that may - // be used for `PAGE_OPTIMIZATION`. + // be used for PAGE_OPTIMIZATION. ServingConfigIds []string `json:"servingConfigIds,omitempty"` // ForceSendFields is a list of field names (e.g. "ServingConfigIds") to @@ -3534,7 +3531,7 @@ func (s *GoogleCloudRetailV2betaFulfillmentInfo) MarshalJSON() ([]byte, error) { } // GoogleCloudRetailV2betaGcsSource: Google Cloud Storage location for -// input content. +// input content. format. type GoogleCloudRetailV2betaGcsSource struct { // DataSchema: The schema to use when parsing the data from the source. // Supported values for product imports: * `product` (default): One JSON @@ -3545,9 +3542,9 @@ type GoogleCloudRetailV2betaGcsSource struct { // Supported values for user events imports: * `user_event` (default): // One JSON UserEvent per line. * `user_event_ga360`: Using // https://support.google.com/analytics/answer/3437719. Supported values - // for control imports: * `control` (default): One JSON Control per + // for control imports: * 'control' (default): One JSON Control per // line. Supported values for catalog attribute imports: * - // `catalog_attribute` (default): One CSV CatalogAttribute per line. + // 'catalog_attribute' (default): One CSV CatalogAttribute per line. DataSchema string `json:"dataSchema,omitempty"` // InputUris: Required. Google Cloud Storage URIs to input files. URI @@ -3674,9 +3671,9 @@ type GoogleCloudRetailV2betaImportCompletionDataRequest struct { InputConfig *GoogleCloudRetailV2betaCompletionDataInputConfig `json:"inputConfig,omitempty"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -3740,7 +3737,7 @@ func (s *GoogleCloudRetailV2betaImportCompletionDataResponse) MarshalJSON() ([]b // destination for Import related errors. type GoogleCloudRetailV2betaImportErrorsConfig struct { // GcsPrefix: Google Cloud Storage prefix for import errors. This must - // be an empty, existing Cloud Storage directory. Import errors are + // be an empty, existing Cloud Storage directory. Import errors will be // written to sharded files in this directory, one per line, as a // JSON-encoded `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -3769,7 +3766,7 @@ func (s *GoogleCloudRetailV2betaImportErrorsConfig) MarshalJSON() ([]byte, error } // GoogleCloudRetailV2betaImportMetadata: Metadata related to the -// progress of the Import operation. This is returned by the +// progress of the Import operation. This will be returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2betaImportMetadata struct { // CreateTime: Operation create time. @@ -3780,9 +3777,9 @@ type GoogleCloudRetailV2betaImportMetadata struct { FailureCount int64 `json:"failureCount,omitempty,string"` // NotificationPubsubTopic: Pub/Sub topic for receiving notification. If - // this field is set, when the import is finished, a notification is - // sent to specified Pub/Sub topic. The message data is JSON string of a - // Operation. Format of the Pub/Sub topic is + // this field is set, when the import is finished, a notification will + // be sent to specified Pub/Sub topic. The message data will be JSON + // string of a Operation. Format of the Pub/Sub topic is // `projects/{project}/topics/{topic}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -3831,9 +3828,9 @@ type GoogleCloudRetailV2betaImportProductsRequest struct { // NotificationPubsubTopic: Full Pub/Sub topic name for receiving // notification. If this field is set, when the import is finished, a - // notification is sent to specified Pub/Sub topic. The message data is - // JSON string of a Operation. Format of the Pub/Sub topic is - // `projects/{project}/topics/{topic}`. It has to be within the same + // notification will be sent to specified Pub/Sub topic. The message + // data will be JSON string of a Operation. Format of the Pub/Sub topic + // is `projects/{project}/topics/{topic}`. It has to be within the same // project as ImportProductsRequest.parent. Make sure that // `service-@gcp-sa-retail.iam.gserviceaccount.com` has the // `pubsub.topics.publish` IAM permission on the topic. @@ -3855,7 +3852,7 @@ type GoogleCloudRetailV2betaImportProductsRequest struct { RequestId string `json:"requestId,omitempty"` // UpdateMask: Indicates which fields in the provided imported - // `products` to update. If not set, all fields are updated. + // 'products' to update. If not set, will by default update all fields. UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorsConfig") to @@ -10259,12 +10256,9 @@ type ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall struct { // processed downstream. As a consequence, when a response is returned, // the added place IDs are not immediately manifested in the Product // queried by ProductService.GetProduct or ProductService.ListProducts. -// The returned Operations will be obsolete after 1 day, and -// GetOperation API will return NOT_FOUND afterwards. If conflicting -// updates are issued, the Operations associated with the stale updates -// will not be marked as done until being obsolete. This feature is only -// available for users who have Retail Search enabled. Please enable -// Retail Search on Cloud Console before using this feature. +// This feature is only available for users who have Retail Search +// enabled. Please enable Retail Search on Cloud Console before using +// this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10369,7 +10363,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall) Do(o } return ret, nil // { - // "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -10420,13 +10414,9 @@ type ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall struct { // ProductService.GetProduct or ProductService.ListProducts. Local // inventory information can only be modified using this method. // ProductService.CreateProduct and ProductService.UpdateProduct has no -// effect on local inventories. The returned Operations will be obsolete -// after 1 day, and GetOperation API will return NOT_FOUND afterwards. -// If conflicting updates are issued, the Operations associated with the -// stale updates will not be marked as done until being obsolete. This -// feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this -// feature. +// effect on local inventories. This feature is only available for users +// who have Retail Search enabled. Please enable Retail Search on Cloud +// Console before using this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10531,7 +10521,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall) Do(op } return ret, nil // { - // "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -11604,12 +11594,9 @@ type ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall struct // processed downstream. As a consequence, when a response is returned, // the removed place IDs are not immediately manifested in the Product // queried by ProductService.GetProduct or ProductService.ListProducts. -// The returned Operations will be obsolete after 1 day, and -// GetOperation API will return NOT_FOUND afterwards. If conflicting -// updates are issued, the Operations associated with the stale updates -// will not be marked as done until being obsolete. This feature is only -// available for users who have Retail Search enabled. Please enable -// Retail Search on Cloud Console before using this feature. +// This feature is only available for users who have Retail Search +// enabled. Please enable Retail Search on Cloud Console before using +// this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -11714,7 +11701,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall) D } return ret, nil // { - // "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -11763,13 +11750,9 @@ type ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall struct // queried by ProductService.GetProduct or ProductService.ListProducts. // Local inventory information can only be removed using this method. // ProductService.CreateProduct and ProductService.UpdateProduct has no -// effect on local inventories. The returned Operations will be obsolete -// after 1 day, and GetOperation API will return NOT_FOUND afterwards. -// If conflicting updates are issued, the Operations associated with the -// stale updates will not be marked as done until being obsolete. This -// feature is only available for users who have Retail Search enabled. -// Please enable Retail Search on Cloud Console before using this -// feature. +// effect on local inventories. This feature is only available for users +// who have Retail Search enabled. Please enable Retail Search on Cloud +// Console before using this feature. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -11874,7 +11857,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall) Do } return ret, nil // { - // "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -11935,13 +11918,9 @@ type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct { // information will be preserved. Pre-existing inventory information can // only be updated with ProductService.SetInventory, // ProductService.AddFulfillmentPlaces, and -// ProductService.RemoveFulfillmentPlaces. The returned Operations will -// be obsolete after 1 day, and GetOperation API will return NOT_FOUND -// afterwards. If conflicting updates are issued, the Operations -// associated with the stale updates will not be marked as done until -// being obsolete. This feature is only available for users who have -// Retail Search enabled. Please enable Retail Search on Cloud Console -// before using this feature. +// ProductService.RemoveFulfillmentPlaces. This feature is only +// available for users who have Retail Search enabled. Please enable +// Retail Search on Cloud Console before using this feature. // // - name: Immutable. Full resource name of the product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12044,7 +12023,7 @@ func (c *ProjectsLocationsCatalogsBranchesProductsSetInventoryCall) Do(opts ...g } return ret, nil // { - // "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", + // "description": "Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -15361,10 +15340,10 @@ type ProjectsLocationsCatalogsUserEventsImportCall struct { // Import: Bulk import of User events. Request processing might be // synchronous. Events that already exist are skipped. Use this method -// for backfilling historical user events. `Operation.response` is of -// type `ImportResponse`. Note that it is possible for a subset of the -// items to be successfully inserted. `Operation.metadata` is of type -// `ImportMetadata`. +// for backfilling historical user events. Operation.response is of type +// ImportResponse. Note that it is possible for a subset of the items to +// be successfully inserted. Operation.metadata is of type +// ImportMetadata. // // - parent: `projects/1234/locations/global/catalogs/default_catalog`. func (r *ProjectsLocationsCatalogsUserEventsService) Import(parent string, googlecloudretailv2betaimportusereventsrequest *GoogleCloudRetailV2betaImportUserEventsRequest) *ProjectsLocationsCatalogsUserEventsImportCall { @@ -15465,7 +15444,7 @@ func (c *ProjectsLocationsCatalogsUserEventsImportCall) Do(opts ...googleapi.Cal } return ret, nil // { - // "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", + // "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.userEvents.import",