diff --git a/api-list.json b/api-list.json index 12b97357084..c32199630ab 100644 --- a/api-list.json +++ b/api-list.json @@ -1276,21 +1276,6 @@ "documentationLink": "https://cloud.google.com/identity/", "preferred": true }, - { - "kind": "discovery#directoryItem", - "id": "cloudiot:v1", - "name": "cloudiot", - "version": "v1", - "title": "Cloud IoT API", - "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.", - "discoveryRestUrl": "https://cloudiot.googleapis.com/$discovery/rest?version=v1", - "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "documentationLink": "https://cloud.google.com/iot", - "preferred": true - }, { "kind": "discovery#directoryItem", "id": "cloudkms:v1", diff --git a/apigateway/v1/apigateway-api.json b/apigateway/v1/apigateway-api.json index e75d6fb45b7..d13e645f755 100644 --- a/apigateway/v1/apigateway-api.json +++ b/apigateway/v1/apigateway-api.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220504", + "revision": "20220811", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1336,7 +1336,7 @@ "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/apigateway/v1/apigateway-gen.go b/apigateway/v1/apigateway-gen.go index f4286b08b16..3500b9b01ba 100644 --- a/apigateway/v1/apigateway-gen.go +++ b/apigateway/v1/apigateway-gen.go @@ -586,16 +586,20 @@ type ApigatewayBinding struct { // who is authenticated with a Google account or a service account. * // `user:{emailid}`: An email address that represents a specific Google // account. For example, `alice@example.com` . * - // `serviceAccount:{emailid}`: An email address that represents a + // `serviceAccount:{emailid}`: An email address that represents a Google // service account. For example, - // `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An - // email address that represents a Google group. For example, - // `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An - // email address (plus unique identifier) representing a user that has - // been recently deleted. For example, - // `alice@example.com?uid=123456789012345678901`. If the user is - // recovered, this value reverts to `user:{emailid}` and the recovered - // user retains the role in the binding. * + // `my-other-app@appspot.gserviceaccount.com`. * + // `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + // An identifier for a Kubernetes service account + // (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + // For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. + // * `group:{emailid}`: An email address that represents a Google group. + // For example, `admins@example.com`. * + // `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + // unique identifier) representing a user that has been recently + // deleted. For example, `alice@example.com?uid=123456789012345678901`. + // If the user is recovered, this value reverts to `user:{emailid}` and + // the recovered user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, diff --git a/clouddeploy/v1/clouddeploy-api.json b/clouddeploy/v1/clouddeploy-api.json index 51895b6787c..696951e67ab 100644 --- a/clouddeploy/v1/clouddeploy-api.json +++ b/clouddeploy/v1/clouddeploy-api.json @@ -1229,7 +1229,7 @@ } } }, - "revision": "20220609", + "revision": "20220811", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -1329,7 +1329,7 @@ "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -2158,7 +2158,7 @@ "type": "string" }, "deployFailureCause": { - "description": "Output only. The reason this deploy failed. This will always be unspecified while the deploy in progress.", + "description": "Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.", "enum": [ "FAILURE_CAUSE_UNSPECIFIED", "CLOUD_BUILD_UNAVAILABLE", @@ -2204,7 +2204,7 @@ "type": "string" }, "failureReason": { - "description": "Output only. Reason the build failed. Empty if the build succeeded.", + "description": "Output only. Additional information about the rollout failure, if available.", "readOnly": true, "type": "string" }, diff --git a/clouddeploy/v1/clouddeploy-gen.go b/clouddeploy/v1/clouddeploy-gen.go index fd77e715b58..d671a877312 100644 --- a/clouddeploy/v1/clouddeploy-gen.go +++ b/clouddeploy/v1/clouddeploy-gen.go @@ -412,16 +412,20 @@ type Binding struct { // who is authenticated with a Google account or a service account. * // `user:{emailid}`: An email address that represents a specific Google // account. For example, `alice@example.com` . * - // `serviceAccount:{emailid}`: An email address that represents a + // `serviceAccount:{emailid}`: An email address that represents a Google // service account. For example, - // `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An - // email address that represents a Google group. For example, - // `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An - // email address (plus unique identifier) representing a user that has - // been recently deleted. For example, - // `alice@example.com?uid=123456789012345678901`. If the user is - // recovered, this value reverts to `user:{emailid}` and the recovered - // user retains the role in the binding. * + // `my-other-app@appspot.gserviceaccount.com`. * + // `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + // An identifier for a Kubernetes service account + // (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + // For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. + // * `group:{emailid}`: An email address that represents a Google group. + // For example, `admins@example.com`. * + // `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + // unique identifier) representing a user that has been recently + // deleted. For example, `alice@example.com?uid=123456789012345678901`. + // If the user is recovered, this value reverts to `user:{emailid}` and + // the recovered user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, @@ -1786,8 +1790,8 @@ type Rollout struct { // deploying. DeployEndTime string `json:"deployEndTime,omitempty"` - // DeployFailureCause: Output only. The reason this deploy failed. This - // will always be unspecified while the deploy in progress. + // DeployFailureCause: Output only. The reason this rollout failed. This + // will always be unspecified while the rollout is in progress. // // Possible values: // "FAILURE_CAUSE_UNSPECIFIED" - No reason for failure is specified. @@ -1825,8 +1829,8 @@ type Rollout struct { // the client has an up-to-date value before proceeding. Etag string `json:"etag,omitempty"` - // FailureReason: Output only. Reason the build failed. Empty if the - // build succeeded. + // FailureReason: Output only. Additional information about the rollout + // failure, if available. FailureReason string `json:"failureReason,omitempty"` // Labels: Labels are attributes that can be set and used by both the diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json index 9bfc22ef740..4e2d62cab26 100644 --- a/dataflow/v1b3/dataflow-api.json +++ b/dataflow/v1b3/dataflow-api.json @@ -2225,7 +2225,7 @@ } } }, - "revision": "20220806", + "revision": "20220812", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3349,6 +3349,10 @@ "description": "If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap dump before ending the thread or process. If false, ends the thread or process without saving a heap dump. Does not save a heap dump when the Java Virtual Machine (JVM) has an out of memory error during processing. The location of the heap file is either echoed back to the user, or the user is given the opportunity to download the heap file.", "type": "boolean" }, + "enableLauncherVmSerialPortLogging": { + "description": "If true serial port logging will be enabled for the launcher VM.", + "type": "boolean" + }, "enableStreamingEngine": { "description": "Whether to enable Streaming Engine for the job.", "type": "boolean" diff --git a/dataflow/v1b3/dataflow-gen.go b/dataflow/v1b3/dataflow-gen.go index 264f09bd768..89906d1180f 100644 --- a/dataflow/v1b3/dataflow-gen.go +++ b/dataflow/v1b3/dataflow-gen.go @@ -2117,6 +2117,10 @@ type FlexTemplateRuntimeEnvironment struct { // user is given the opportunity to download the heap file. DumpHeapOnOom bool `json:"dumpHeapOnOom,omitempty"` + // EnableLauncherVmSerialPortLogging: If true serial port logging will + // be enabled for the launcher VM. + EnableLauncherVmSerialPortLogging bool `json:"enableLauncherVmSerialPortLogging,omitempty"` + // EnableStreamingEngine: Whether to enable Streaming Engine for the // job. EnableStreamingEngine bool `json:"enableStreamingEngine,omitempty"` diff --git a/gkebackup/v1/gkebackup-api.json b/gkebackup/v1/gkebackup-api.json index 77485389bd3..f1c6dbf4303 100644 --- a/gkebackup/v1/gkebackup-api.json +++ b/gkebackup/v1/gkebackup-api.json @@ -1688,7 +1688,7 @@ } } }, - "revision": "20220714", + "revision": "20220811", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2019,7 +2019,7 @@ "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, diff --git a/gkebackup/v1/gkebackup-gen.go b/gkebackup/v1/gkebackup-gen.go index 1e1bdec3c02..a80bf1a8612 100644 --- a/gkebackup/v1/gkebackup-gen.go +++ b/gkebackup/v1/gkebackup-gen.go @@ -675,16 +675,20 @@ type Binding struct { // who is authenticated with a Google account or a service account. * // `user:{emailid}`: An email address that represents a specific Google // account. For example, `alice@example.com` . * - // `serviceAccount:{emailid}`: An email address that represents a + // `serviceAccount:{emailid}`: An email address that represents a Google // service account. For example, - // `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An - // email address that represents a Google group. For example, - // `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An - // email address (plus unique identifier) representing a user that has - // been recently deleted. For example, - // `alice@example.com?uid=123456789012345678901`. If the user is - // recovered, this value reverts to `user:{emailid}` and the recovered - // user retains the role in the binding. * + // `my-other-app@appspot.gserviceaccount.com`. * + // `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + // An identifier for a Kubernetes service account + // (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + // For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. + // * `group:{emailid}`: An email address that represents a Google group. + // For example, `admins@example.com`. * + // `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + // unique identifier) representing a user that has been recently + // deleted. For example, `alice@example.com?uid=123456789012345678901`. + // If the user is recovered, this value reverts to `user:{emailid}` and + // the recovered user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, diff --git a/networkmanagement/v1/networkmanagement-api.json b/networkmanagement/v1/networkmanagement-api.json index 224ce294c58..d0b5883970b 100644 --- a/networkmanagement/v1/networkmanagement-api.json +++ b/networkmanagement/v1/networkmanagement-api.json @@ -591,7 +591,7 @@ } } }, - "revision": "20220504", + "revision": "20220812", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -638,6 +638,13 @@ ], "type": "string" }, + "projectsMissingPermission": { + "description": "List of project IDs that the user has specified in the request but does not have permission to access network configs. Analysis is aborted in this case with the PERMISSION_DENIED cause.", + "items": { + "type": "string" + }, + "type": "array" + }, "resourceUri": { "description": "URI of the resource that caused the abort.", "type": "string" @@ -702,7 +709,7 @@ "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -721,6 +728,41 @@ "properties": {}, "type": "object" }, + "CloudFunctionEndpoint": { + "description": "Wrapper for cloud function attributes.", + "id": "CloudFunctionEndpoint", + "properties": { + "uri": { + "description": "A [Cloud function](https://cloud.google.com/functions) name.", + "type": "string" + } + }, + "type": "object" + }, + "CloudFunctionInfo": { + "description": "For display only. Metadata associated with a Cloud function.", + "id": "CloudFunctionInfo", + "properties": { + "displayName": { + "description": "Name of a Cloud function.", + "type": "string" + }, + "location": { + "description": "Location in which the Cloud function is deployed.", + "type": "string" + }, + "uri": { + "description": "URI of a Cloud function.", + "type": "string" + }, + "versionId": { + "description": "Latest successfully deployed version id of the Cloud function.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "CloudSQLInstanceInfo": { "description": "For display only. Metadata associated with a Cloud SQL instance.", "id": "CloudSQLInstanceInfo", @@ -874,7 +916,10 @@ "DROPPED_INSIDE_GKE_SERVICE", "DROPPED_INSIDE_CLOUD_SQL_SERVICE", "GOOGLE_MANAGED_SERVICE_NO_PEERING", - "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS" + "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS", + "CLOUD_FUNCTION_NOT_ACTIVE", + "VPC_CONNECTOR_NOT_SET", + "VPC_CONNECTOR_NOT_RUNNING" ], "enumDescriptions": [ "Cause is unspecified.", @@ -898,7 +943,10 @@ "Packet was dropped inside Google Kubernetes Engine Service.", "Packet was dropped inside Cloud SQL Service.", "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", - "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address." + "Packet was dropped because the Cloud SQL instance has neither a private nor a public IP address.", + "Packet could be dropped because the Cloud function is not in an active status.", + "Packet could be dropped because no VPC connector is set.", + "Packet could be dropped because the VPC connector is not in a running state." ], "type": "string" }, @@ -919,6 +967,10 @@ "description": "Source or destination of the Connectivity Test.", "id": "Endpoint", "properties": { + "cloudFunction": { + "$ref": "CloudFunctionEndpoint", + "description": "A [Cloud function](https://cloud.google.com/functions)." + }, "cloudSqlInstance": { "description": "A [Cloud SQL](https://cloud.google.com/sql) instance URI.", "type": "string" @@ -1047,13 +1099,15 @@ "FIREWALL_RULE_TYPE_UNSPECIFIED", "HIERARCHICAL_FIREWALL_POLICY_RULE", "VPC_FIREWALL_RULE", - "IMPLIED_VPC_FIREWALL_RULE" + "IMPLIED_VPC_FIREWALL_RULE", + "SERVERLESS_VPC_ACCESS_MANAGED_FIREWALL_RULE" ], "enumDescriptions": [ "Unspecified type.", "Hierarchical firewall policy rule. For details, see [Hierarchical firewall policies overview](https://cloud.google.com/vpc/docs/firewall-policies).", "VPC firewall rule. For details, see [VPC firewall rules overview](https://cloud.google.com/vpc/docs/firewalls).", - "Implied VPC firewall rule. For details, see [Implied rules](https://cloud.google.com/vpc/docs/firewalls#default_firewall_rules)." + "Implied VPC firewall rule. For details, see [Implied rules](https://cloud.google.com/vpc/docs/firewalls#default_firewall_rules).", + "Implicit firewall rules that are managed by serverless VPC access to allow ingress access. They are not visible in the Google Cloud console. For details, see [VPC connector's implicit rules](https://cloud.google.com/functions/docs/networking/connecting-vpc#restrict-access)." ], "type": "string" }, @@ -1735,6 +1789,10 @@ "description": "This is a step that leads to the final state Drop.", "type": "boolean" }, + "cloudFunction": { + "$ref": "CloudFunctionInfo", + "description": "Display information of a Cloud function." + }, "cloudSqlInstance": { "$ref": "CloudSQLInstanceInfo", "description": "Display information of a Cloud SQL instance." @@ -1800,6 +1858,7 @@ "START_FROM_PRIVATE_NETWORK", "START_FROM_GKE_MASTER", "START_FROM_CLOUD_SQL_INSTANCE", + "START_FROM_CLOUD_FUNCTION", "APPLY_INGRESS_FIREWALL_RULE", "APPLY_EGRESS_FIREWALL_RULE", "APPLY_ROUTE", @@ -1810,6 +1869,7 @@ "ARRIVE_AT_EXTERNAL_LOAD_BALANCER", "ARRIVE_AT_VPN_GATEWAY", "ARRIVE_AT_VPN_TUNNEL", + "ARRIVE_AT_VPC_CONNECTOR", "NAT", "PROXY_CONNECTION", "DELIVER", @@ -1825,6 +1885,7 @@ "Initial state: packet originating from a VPC or on-premises network with internal source IP. If the source is a VPC network visible to the user, a NetworkInfo is populated with details of the network.", "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information.", + "Initial state: packet originating from a Cloud function. A CloudFunctionInfo is populated with starting function information.", "Config checking state: verify ingress firewall rule.", "Config checking state: verify egress firewall rule.", "Config checking state: verify route.", @@ -1835,6 +1896,7 @@ "Forwarding state: arriving at a Compute Engine external load balancer.", "Forwarding state: arriving at a Cloud VPN gateway.", "Forwarding state: arriving at a Cloud VPN tunnel.", + "Forwarding state: arriving at a VPC connector.", "Transition state: packet header translated.", "Transition state: original connection is terminated and a new proxied connection is initiated.", "Final state: packet could be delivered.", @@ -1845,6 +1907,10 @@ ], "type": "string" }, + "vpcConnector": { + "$ref": "VpcConnectorInfo", + "description": "Display information of a VPC connector." + }, "vpnGateway": { "$ref": "VpnGatewayInfo", "description": "Display information of a Compute Engine VPN gateway." @@ -1902,6 +1968,25 @@ }, "type": "object" }, + "VpcConnectorInfo": { + "description": "For display only. Metadata associated with a VPC connector.", + "id": "VpcConnectorInfo", + "properties": { + "displayName": { + "description": "Name of a VPC connector.", + "type": "string" + }, + "location": { + "description": "Location in which the VPC connector is deployed.", + "type": "string" + }, + "uri": { + "description": "URI of a VPC connector.", + "type": "string" + } + }, + "type": "object" + }, "VpnGatewayInfo": { "description": "For display only. Metadata associated with a Compute Engine VPN gateway.", "id": "VpnGatewayInfo", diff --git a/networkmanagement/v1/networkmanagement-gen.go b/networkmanagement/v1/networkmanagement-gen.go index 1d66ffa26ac..b37a6a3da44 100644 --- a/networkmanagement/v1/networkmanagement-gen.go +++ b/networkmanagement/v1/networkmanagement-gen.go @@ -239,6 +239,12 @@ type AbortInfo struct { // "UNSUPPORTED" - Aborted because the test scenario is not supported. Cause string `json:"cause,omitempty"` + // ProjectsMissingPermission: List of project IDs that the user has + // specified in the request but does not have permission to access + // network configs. Analysis is aborted in this case with the + // PERMISSION_DENIED cause. + ProjectsMissingPermission []string `json:"projectsMissingPermission,omitempty"` + // ResourceUri: URI of the resource that caused the abort. ResourceUri string `json:"resourceUri,omitempty"` @@ -382,16 +388,20 @@ type Binding struct { // who is authenticated with a Google account or a service account. * // `user:{emailid}`: An email address that represents a specific Google // account. For example, `alice@example.com` . * - // `serviceAccount:{emailid}`: An email address that represents a + // `serviceAccount:{emailid}`: An email address that represents a Google // service account. For example, - // `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An - // email address that represents a Google group. For example, - // `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An - // email address (plus unique identifier) representing a user that has - // been recently deleted. For example, - // `alice@example.com?uid=123456789012345678901`. If the user is - // recovered, this value reverts to `user:{emailid}` and the recovered - // user retains the role in the binding. * + // `my-other-app@appspot.gserviceaccount.com`. * + // `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + // An identifier for a Kubernetes service account + // (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + // For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. + // * `group:{emailid}`: An email address that represents a Google group. + // For example, `admins@example.com`. * + // `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + // unique identifier) representing a user that has been recently + // deleted. For example, `alice@example.com?uid=123456789012345678901`. + // If the user is recovered, this value reverts to `user:{emailid}` and + // the recovered user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, @@ -440,6 +450,73 @@ func (s *Binding) MarshalJSON() ([]byte, error) { type CancelOperationRequest struct { } +// CloudFunctionEndpoint: Wrapper for cloud function attributes. +type CloudFunctionEndpoint struct { + // Uri: A Cloud function (https://cloud.google.com/functions) name. + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Uri") 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. "Uri") 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 *CloudFunctionEndpoint) MarshalJSON() ([]byte, error) { + type NoMethod CloudFunctionEndpoint + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloudFunctionInfo: For display only. Metadata associated with a Cloud +// function. +type CloudFunctionInfo struct { + // DisplayName: Name of a Cloud function. + DisplayName string `json:"displayName,omitempty"` + + // Location: Location in which the Cloud function is deployed. + Location string `json:"location,omitempty"` + + // Uri: URI of a Cloud function. + Uri string `json:"uri,omitempty"` + + // VersionId: Latest successfully deployed version id of the Cloud + // function. + VersionId int64 `json:"versionId,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 *CloudFunctionInfo) MarshalJSON() ([]byte, error) { + type NoMethod CloudFunctionInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // CloudSQLInstanceInfo: For display only. Metadata associated with a // Cloud SQL instance. type CloudSQLInstanceInfo struct { @@ -690,6 +767,12 @@ type DropInfo struct { // Managed Services Network. // "CLOUD_SQL_INSTANCE_NO_IP_ADDRESS" - Packet was dropped because the // Cloud SQL instance has neither a private nor a public IP address. + // "CLOUD_FUNCTION_NOT_ACTIVE" - Packet could be dropped because the + // Cloud function is not in an active status. + // "VPC_CONNECTOR_NOT_SET" - Packet could be dropped because no VPC + // connector is set. + // "VPC_CONNECTOR_NOT_RUNNING" - Packet could be dropped because the + // VPC connector is not in a running state. Cause string `json:"cause,omitempty"` // ResourceUri: URI of the resource that caused the drop. @@ -731,6 +814,9 @@ type Empty struct { // Endpoint: Source or destination of the Connectivity Test. type Endpoint struct { + // CloudFunction: A Cloud function (https://cloud.google.com/functions). + CloudFunction *CloudFunctionEndpoint `json:"cloudFunction,omitempty"` + // CloudSqlInstance: A Cloud SQL (https://cloud.google.com/sql) instance // URI. CloudSqlInstance string `json:"cloudSqlInstance,omitempty"` @@ -779,7 +865,7 @@ type Endpoint struct { // project. ProjectId string `json:"projectId,omitempty"` - // ForceSendFields is a list of field names (e.g. "CloudSqlInstance") to + // ForceSendFields is a list of field names (e.g. "CloudFunction") 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 @@ -787,13 +873,12 @@ type Endpoint struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CloudSqlInstance") 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. "CloudFunction") 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:"-"` } @@ -943,6 +1028,12 @@ type FirewallInfo struct { // details, see [Implied // rules](https://cloud.google.com/vpc/docs/firewalls#default_firewall_ru // les). + // "SERVERLESS_VPC_ACCESS_MANAGED_FIREWALL_RULE" - Implicit firewall + // rules that are managed by serverless VPC access to allow ingress + // access. They are not visible in the Google Cloud console. For + // details, see [VPC connector's implicit + // rules](https://cloud.google.com/functions/docs/networking/connecting-v + // pc#restrict-access). FirewallRuleType string `json:"firewallRuleType,omitempty"` // NetworkUri: The URI of the VPC network that the firewall rule is @@ -1948,6 +2039,9 @@ type Step struct { // CausesDrop: This is a step that leads to the final state Drop. CausesDrop bool `json:"causesDrop,omitempty"` + // CloudFunction: Display information of a Cloud function. + CloudFunction *CloudFunctionInfo `json:"cloudFunction,omitempty"` + // CloudSqlInstance: Display information of a Cloud SQL instance. CloudSqlInstance *CloudSQLInstanceInfo `json:"cloudSqlInstance,omitempty"` @@ -2016,6 +2110,9 @@ type Step struct { // "START_FROM_CLOUD_SQL_INSTANCE" - Initial state: packet originating // from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with // starting instance information. + // "START_FROM_CLOUD_FUNCTION" - Initial state: packet originating + // from a Cloud function. A CloudFunctionInfo is populated with starting + // function information. // "APPLY_INGRESS_FIREWALL_RULE" - Config checking state: verify // ingress firewall rule. // "APPLY_EGRESS_FIREWALL_RULE" - Config checking state: verify egress @@ -2035,6 +2132,8 @@ type Step struct { // gateway. // "ARRIVE_AT_VPN_TUNNEL" - Forwarding state: arriving at a Cloud VPN // tunnel. + // "ARRIVE_AT_VPC_CONNECTOR" - Forwarding state: arriving at a VPC + // connector. // "NAT" - Transition state: packet header translated. // "PROXY_CONNECTION" - Transition state: original connection is // terminated and a new proxied connection is initiated. @@ -2048,6 +2147,9 @@ type Step struct { // step. State string `json:"state,omitempty"` + // VpcConnector: Display information of a VPC connector. + VpcConnector *VpcConnectorInfo `json:"vpcConnector,omitempty"` + // VpnGateway: Display information of a Compute Engine VPN gateway. VpnGateway *VpnGatewayInfo `json:"vpnGateway,omitempty"` @@ -2187,6 +2289,41 @@ func (s *Trace) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// VpcConnectorInfo: For display only. Metadata associated with a VPC +// connector. +type VpcConnectorInfo struct { + // DisplayName: Name of a VPC connector. + DisplayName string `json:"displayName,omitempty"` + + // Location: Location in which the VPC connector is deployed. + Location string `json:"location,omitempty"` + + // Uri: URI of a VPC connector. + Uri string `json:"uri,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 *VpcConnectorInfo) MarshalJSON() ([]byte, error) { + type NoMethod VpcConnectorInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // VpnGatewayInfo: For display only. Metadata associated with a Compute // Engine VPN gateway. type VpnGatewayInfo struct { diff --git a/networkmanagement/v1beta1/networkmanagement-api.json b/networkmanagement/v1beta1/networkmanagement-api.json index ec96e92468c..bc57f52ea96 100644 --- a/networkmanagement/v1beta1/networkmanagement-api.json +++ b/networkmanagement/v1beta1/networkmanagement-api.json @@ -591,7 +591,7 @@ } } }, - "revision": "20220602", + "revision": "20220812", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -638,6 +638,13 @@ ], "type": "string" }, + "projectsMissingPermission": { + "description": "List of project IDs that the user has specified in the request but does not have permission to access network configs. Analysis is aborted in this case with the PERMISSION_DENIED cause.", + "items": { + "type": "string" + }, + "type": "array" + }, "resourceUri": { "description": "URI of the resource that caused the abort.", "type": "string" @@ -645,29 +652,6 @@ }, "type": "object" }, - "AppEngineVersionInfo": { - "description": "For display only. Metadata associated with an App Engine version.", - "id": "AppEngineVersionInfo", - "properties": { - "displayName": { - "description": "Name of an App Engine version.", - "type": "string" - }, - "environment": { - "description": "App Engine execution environment for a version.", - "type": "string" - }, - "runtime": { - "description": "Runtime of the App Engine version.", - "type": "string" - }, - "uri": { - "description": "URI of an App Engine version.", - "type": "string" - } - }, - "type": "object" - }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -725,7 +709,7 @@ "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -948,12 +932,14 @@ "VPC_CONNECTOR_NOT_SET", "VPC_CONNECTOR_NOT_RUNNING", "FORWARDING_RULE_REGION_MISMATCH", - "PSC_CONNECTION_NOT_ACCEPTED" + "PSC_CONNECTION_NOT_ACCEPTED", + "GKE_CLUSTER_NOT_RUNNING", + "CLOUD_SQL_INSTANCE_NOT_RUNNING" ], "enumDescriptions": [ "Cause is unspecified.", "Destination external address cannot be resolved to a known target. If the address is used in a Google Cloud project, provide the project ID as test input.", - "a Compute Engine instance can only send or receive a packet with a foreign IP address if ip_forward is enabled.", + "A Compute Engine instance can only send or receive a packet with a foreign IP address if ip_forward is enabled.", "Dropped due to a firewall rule, unless allowed due to connection tracking.", "Dropped due to no routes.", "Dropped due to invalid route. Route's next hop is a blackhole.", @@ -977,7 +963,9 @@ "Packet could be dropped because no VPC connector is set.", "Packet could be dropped because the VPC connector is not in a running state.", "Packet could be dropped because it was sent from a different region to a regional forwarding without global access.", - "Privte Service Connect (PSC) connection is not in accepted state." + "Privte Service Connect (PSC) connection is not in accepted state.", + "Packet sent from or to a GKE cluster that is not in running state.", + "Packet sent from or to a Cloud SQL instance that is not in running state." ], "type": "string" }, @@ -1146,14 +1134,16 @@ "HIERARCHICAL_FIREWALL_POLICY_RULE", "VPC_FIREWALL_RULE", "IMPLIED_VPC_FIREWALL_RULE", - "SERVERLESS_VPC_ACCESS_MANAGED_FIREWALL_RULE" + "SERVERLESS_VPC_ACCESS_MANAGED_FIREWALL_RULE", + "NETWORK_FIREWALL_POLICY_RULE" ], "enumDescriptions": [ "Unspecified type.", "Hierarchical firewall policy rule. For details, see [Hierarchical firewall policies overview](https://cloud.google.com/vpc/docs/firewall-policies).", "VPC firewall rule. For details, see [VPC firewall rules overview](https://cloud.google.com/vpc/docs/firewalls).", "Implied VPC firewall rule. For details, see [Implied rules](https://cloud.google.com/vpc/docs/firewalls#default_firewall_rules).", - "Implicit firewall rules that are managed by serverless VPC access to allow ingress access. They are not visible in the Google Cloud console. For details, see [VPC connector's implicit rules](https://cloud.google.com/functions/docs/networking/connecting-vpc#restrict-access)." + "Implicit firewall rules that are managed by serverless VPC access to allow ingress access. They are not visible in the Google Cloud console. For details, see [VPC connector's implicit rules](https://cloud.google.com/functions/docs/networking/connecting-vpc#restrict-access).", + "Global network firewall policy rule." ], "type": "string" }, @@ -1208,7 +1198,8 @@ "INTERCONNECT", "GKE_MASTER", "IMPORTED_CUSTOM_ROUTE_NEXT_HOP", - "CLOUD_SQL_INSTANCE" + "CLOUD_SQL_INSTANCE", + "ANOTHER_PROJECT" ], "enumDescriptions": [ "Target not specified.", @@ -1217,7 +1208,8 @@ "Forwarded to a Cloud Interconnect connection.", "Forwarded to a Google Kubernetes Engine Container cluster master.", "Forwarded to the next hop of a custom route imported from a peering VPC.", - "Forwarded to a Cloud SQL instance." + "Forwarded to a Cloud SQL instance.", + "Forwarded to a VPC network in another project." ], "type": "string" } @@ -1932,10 +1924,6 @@ "$ref": "AbortInfo", "description": "Display information of the final state \"abort\" and reason." }, - "appEngineVersion": { - "$ref": "AppEngineVersionInfo", - "description": "Display information of an App Engine service version." - }, "causesDrop": { "description": "This is a step that leads to the final state Drop.", "type": "boolean" @@ -2010,7 +1998,6 @@ "START_FROM_GKE_MASTER", "START_FROM_CLOUD_SQL_INSTANCE", "START_FROM_CLOUD_FUNCTION", - "START_FROM_APP_ENGINE_VERSION", "APPLY_INGRESS_FIREWALL_RULE", "APPLY_EGRESS_FIREWALL_RULE", "APPLY_ROUTE", @@ -2038,7 +2025,6 @@ "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud function. A CloudFunctionInfo is populated with starting function information.", - "Initial state: packet originating from an App Engine service version. An AppEngineVersionInfo is populated with starting version information.", "Config checking state: verify ingress firewall rule.", "Config checking state: verify egress firewall rule.", "Config checking state: verify route.", diff --git a/networkmanagement/v1beta1/networkmanagement-gen.go b/networkmanagement/v1beta1/networkmanagement-gen.go index 7aadd086e76..98ca2007acc 100644 --- a/networkmanagement/v1beta1/networkmanagement-gen.go +++ b/networkmanagement/v1beta1/networkmanagement-gen.go @@ -239,6 +239,12 @@ type AbortInfo struct { // "UNSUPPORTED" - Aborted because the test scenario is not supported. Cause string `json:"cause,omitempty"` + // ProjectsMissingPermission: List of project IDs that the user has + // specified in the request but does not have permission to access + // network configs. Analysis is aborted in this case with the + // PERMISSION_DENIED cause. + ProjectsMissingPermission []string `json:"projectsMissingPermission,omitempty"` + // ResourceUri: URI of the resource that caused the abort. ResourceUri string `json:"resourceUri,omitempty"` @@ -265,44 +271,6 @@ func (s *AbortInfo) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// AppEngineVersionInfo: For display only. Metadata associated with an -// App Engine version. -type AppEngineVersionInfo struct { - // DisplayName: Name of an App Engine version. - DisplayName string `json:"displayName,omitempty"` - - // Environment: App Engine execution environment for a version. - Environment string `json:"environment,omitempty"` - - // Runtime: Runtime of the App Engine version. - Runtime string `json:"runtime,omitempty"` - - // Uri: URI of an App Engine version. - Uri string `json:"uri,omitempty"` - - // ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 *AppEngineVersionInfo) MarshalJSON() ([]byte, error) { - type NoMethod AppEngineVersionInfo - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // AuditConfig: Specifies the audit configuration for a service. The // configuration determines which permission types are logged, and what // identities, if any, are exempted from logging. An AuditConfig must @@ -420,16 +388,20 @@ type Binding struct { // who is authenticated with a Google account or a service account. * // `user:{emailid}`: An email address that represents a specific Google // account. For example, `alice@example.com` . * - // `serviceAccount:{emailid}`: An email address that represents a + // `serviceAccount:{emailid}`: An email address that represents a Google // service account. For example, - // `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An - // email address that represents a Google group. For example, - // `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An - // email address (plus unique identifier) representing a user that has - // been recently deleted. For example, - // `alice@example.com?uid=123456789012345678901`. If the user is - // recovered, this value reverts to `user:{emailid}` and the recovered - // user retains the role in the binding. * + // `my-other-app@appspot.gserviceaccount.com`. * + // `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + // An identifier for a Kubernetes service account + // (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + // For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. + // * `group:{emailid}`: An email address that represents a Google group. + // For example, `admins@example.com`. * + // `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + // unique identifier) representing a user that has been recently + // deleted. For example, `alice@example.com?uid=123456789012345678901`. + // If the user is recovered, this value reverts to `user:{emailid}` and + // the recovered user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, @@ -752,7 +724,7 @@ type DropInfo struct { // "UNKNOWN_EXTERNAL_ADDRESS" - Destination external address cannot be // resolved to a known target. If the address is used in a Google Cloud // project, provide the project ID as test input. - // "FOREIGN_IP_DISALLOWED" - a Compute Engine instance can only send + // "FOREIGN_IP_DISALLOWED" - A Compute Engine instance can only send // or receive a packet with a foreign IP address if ip_forward is // enabled. // "FIREWALL_RULE" - Dropped due to a firewall rule, unless allowed @@ -822,6 +794,10 @@ type DropInfo struct { // global access. // "PSC_CONNECTION_NOT_ACCEPTED" - Privte Service Connect (PSC) // connection is not in accepted state. + // "GKE_CLUSTER_NOT_RUNNING" - Packet sent from or to a GKE cluster + // that is not in running state. + // "CLOUD_SQL_INSTANCE_NOT_RUNNING" - Packet sent from or to a Cloud + // SQL instance that is not in running state. Cause string `json:"cause,omitempty"` // ResourceUri: URI of the resource that caused the drop. @@ -1117,6 +1093,8 @@ type FirewallInfo struct { // details, see [VPC connector's implicit // rules](https://cloud.google.com/functions/docs/networking/connecting-v // pc#restrict-access). + // "NETWORK_FIREWALL_POLICY_RULE" - Global network firewall policy + // rule. FirewallRuleType string `json:"firewallRuleType,omitempty"` // NetworkUri: The URI of the VPC network that the firewall rule is @@ -1184,6 +1162,7 @@ type ForwardInfo struct { // "IMPORTED_CUSTOM_ROUTE_NEXT_HOP" - Forwarded to the next hop of a // custom route imported from a peering VPC. // "CLOUD_SQL_INSTANCE" - Forwarded to a Cloud SQL instance. + // "ANOTHER_PROJECT" - Forwarded to a VPC network in another project. Target string `json:"target,omitempty"` // ForceSendFields is a list of field names (e.g. "ResourceUri") to @@ -2262,10 +2241,6 @@ type Step struct { // Abort: Display information of the final state "abort" and reason. Abort *AbortInfo `json:"abort,omitempty"` - // AppEngineVersion: Display information of an App Engine service - // version. - AppEngineVersion *AppEngineVersionInfo `json:"appEngineVersion,omitempty"` - // CausesDrop: This is a step that leads to the final state Drop. CausesDrop bool `json:"causesDrop,omitempty"` @@ -2343,9 +2318,6 @@ type Step struct { // "START_FROM_CLOUD_FUNCTION" - Initial state: packet originating // from a Cloud function. A CloudFunctionInfo is populated with starting // function information. - // "START_FROM_APP_ENGINE_VERSION" - Initial state: packet originating - // from an App Engine service version. An AppEngineVersionInfo is - // populated with starting version information. // "APPLY_INGRESS_FIREWALL_RULE" - Config checking state: verify // ingress firewall rule. // "APPLY_EGRESS_FIREWALL_RULE" - Config checking state: verify egress diff --git a/retail/v2/retail-api.json b/retail/v2/retail-api.json index f7dacc0450d..bfc3b484a08 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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. format.", + "description": "Google Cloud Storage location for input content.", "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 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}`.", + "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}`.", "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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "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 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.", + "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.", "type": "string" }, "reconciliationMode": { @@ -2173,7 +2173,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported `products` to update. If not set, all fields are updated.", "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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "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 Cosole 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 Console 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', `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`, and `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. e.g. 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. For example, 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 (in case the model fails at serving time, we can fall back to the default)." + "description": "Required. The default candidate. If the model fails at serving time, we 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 / may be used for PAGE_OPTIMIZATION recommendations.", + "description": "Represents an ordered combination of valid serving configs, which can 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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "type": "string" }, "requestId": { diff --git a/retail/v2/retail-gen.go b/retail/v2/retail-gen.go index 3b5acadf44d..4694093ef57 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. format. +// content. 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 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 + // 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}`. 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 will be + // 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. 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 will be returned by the +// of the Import operation. This is 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 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 + // 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}`. 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 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 + // 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. @@ -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, will by default update all fields. + // `products` to update. If not set, all fields are updated. 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 will be + // 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. 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 will be returned by the +// progress of the Import operation. This is 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 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 + // 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}`. 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,10 +5381,11 @@ type GoogleCloudRetailV2alphaModel struct { // DisplayName: 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. + // Console 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: @@ -5403,8 +5404,8 @@ type GoogleCloudRetailV2alphaModel struct { // Name: 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. + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_i + // d}/models/{model_id}` catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. Name string `json:"name,omitempty"` @@ -5421,19 +5422,20 @@ 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"` @@ -5441,23 +5443,24 @@ 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. @@ -5472,8 +5475,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', `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, `similar-items`, + // `buy-it-again`, and `recently-viewed`(readonly value). Type string `json:"type,omitempty"` // UpdateTime: Output only. Timestamp the Recommendation Model was last @@ -5550,21 +5553,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, @@ -5577,7 +5580,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) @@ -5617,10 +5620,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. - // e.g. for a ServingConfig with full name: + // ServingConfigId: This has to be a valid ServingConfig identifier. For + // example, 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 @@ -5654,8 +5657,8 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct { // = 10. Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"` - // DefaultCandidate: Required. The default candidate (in case the model - // fails at serving time, we can fall back to the default). + // DefaultCandidate: Required. The default candidate. If the model fails + // at serving time, we fall back to the default. DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"` // DisplayName: Optional. The name to display for the panel. @@ -5685,11 +5688,11 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel) MarshalJSON() } // GoogleCloudRetailV2alphaModelServingConfigList: Represents an ordered -// combination of valid serving configs, which / may be used for -// PAGE_OPTIMIZATION recommendations. +// combination of valid serving configs, which can 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 @@ -6292,7 +6295,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 will be + // 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. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -6321,7 +6324,7 @@ func (s *GoogleCloudRetailV2betaImportErrorsConfig) MarshalJSON() ([]byte, error } // GoogleCloudRetailV2betaImportMetadata: Metadata related to the -// progress of the Import operation. This will be returned by the +// progress of the Import operation. This is returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2betaImportMetadata struct { // CreateTime: Operation create time. @@ -6332,9 +6335,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 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 + // 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}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -8843,9 +8846,12 @@ 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. -// This feature is only available for users who have Retail Search -// enabled. Please enable Retail Search on Cloud Console before using -// this feature. +// 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -8950,7 +8956,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. 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. 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.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -9001,9 +9007,13 @@ 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. 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. 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -9108,7 +9118,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. 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. 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.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -10180,9 +10190,12 @@ 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. -// This feature is only available for users who have Retail Search -// enabled. Please enable Retail Search on Cloud Console before using -// this feature. +// 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10287,7 +10300,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. 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. 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.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -10336,9 +10349,13 @@ 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. 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. 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10443,7 +10460,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. 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. 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.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -10504,9 +10521,13 @@ type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct { // 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. +// 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. // // - name: Immutable. Full resource name of the product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10609,7 +10630,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. 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. 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.", // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -12011,10 +12032,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 { @@ -12115,7 +12136,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 e62736a783d..9c90b683b2c 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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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, periodic_tuning_state. If other values are provided, this API method will ignore them.", + "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.", "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, will by default update all fields.", + "description": "Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates 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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "type": "string" }, "requestId": { @@ -3171,11 +3171,11 @@ "type": "object" }, "GoogleCloudRetailV2alphaGcsSource": { - "description": "Google Cloud Storage location for input content. format.", + "description": "Google Cloud Storage location for input content.", "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 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}`.", + "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}`.", "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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "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 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.", + "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.", "type": "string" }, "reconciliationMode": { @@ -3343,11 +3343,11 @@ "type": "string" }, "skipDefaultBranchProtection": { - "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`.", + "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`.", "type": "boolean" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported `products` to update. If not set, all fields are updated.", "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 Cosole 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 Console 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', `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`, and `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. e.g. 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. For example, 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 (in case the model fails at serving time, we can fall back to the default)." + "description": "Required. The default candidate. If the model fails at serving time, we 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 / may be used for PAGE_OPTIMIZATION recommendations.", + "description": "Represents an ordered combination of valid serving configs, which can 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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "type": "string" }, "requestId": { diff --git a/retail/v2alpha/retail-gen.go b/retail/v2alpha/retail-gen.go index 6a790d1682a..7bf91d811a9 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 will be + // 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. 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 will be returned by the +// of the Import operation. This is 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 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 + // 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}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -2448,7 +2448,7 @@ func (s *GoogleCloudRetailV2alphaFulfillmentInfo) MarshalJSON() ([]byte, error) } // GoogleCloudRetailV2alphaGcsSource: Google Cloud Storage location for -// input content. format. +// input content. 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 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 + // 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}`. 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 will be + // 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. 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 will be returned by the +// progress of the Import operation. This is 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 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 + // 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}`. 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 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 + // 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. @@ -2772,7 +2772,7 @@ type GoogleCloudRetailV2alphaImportProductsRequest struct { // RequestId: Deprecated. This field has no effect. RequestId string `json:"requestId,omitempty"` - // SkipDefaultBranchProtection: If true, will perform the FULL import + // SkipDefaultBranchProtection: 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 @@ -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, will by default update all fields. + // `products` to update. If not set, all fields are updated. 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,10 +3348,11 @@ type GoogleCloudRetailV2alphaModel struct { // DisplayName: 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. + // Console 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: @@ -3370,8 +3371,8 @@ type GoogleCloudRetailV2alphaModel struct { // Name: 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. + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_i + // d}/models/{model_id}` catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. Name string `json:"name,omitempty"` @@ -3388,19 +3389,20 @@ 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"` @@ -3408,23 +3410,24 @@ 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. @@ -3439,8 +3442,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', `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, `similar-items`, + // `buy-it-again`, and `recently-viewed`(readonly value). Type string `json:"type,omitempty"` // UpdateTime: Output only. Timestamp the Recommendation Model was last @@ -3521,21 +3524,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, @@ -3548,7 +3551,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) @@ -3588,10 +3591,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. - // e.g. for a ServingConfig with full name: + // ServingConfigId: This has to be a valid ServingConfig identifier. For + // example, 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 @@ -3625,8 +3628,8 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct { // = 10. Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"` - // DefaultCandidate: Required. The default candidate (in case the model - // fails at serving time, we can fall back to the default). + // DefaultCandidate: Required. The default candidate. If the model fails + // at serving time, we fall back to the default. DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"` // DisplayName: Optional. The name to display for the panel. @@ -3656,11 +3659,11 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel) MarshalJSON() } // GoogleCloudRetailV2alphaModelServingConfigList: Represents an ordered -// combination of valid serving configs, which / may be used for -// PAGE_OPTIMIZATION recommendations. +// combination of valid serving configs, which can 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 @@ -7556,7 +7559,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 will be + // 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. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -7585,7 +7588,7 @@ func (s *GoogleCloudRetailV2betaImportErrorsConfig) MarshalJSON() ([]byte, error } // GoogleCloudRetailV2betaImportMetadata: Metadata related to the -// progress of the Import operation. This will be returned by the +// progress of the Import operation. This is returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2betaImportMetadata struct { // CreateTime: Operation create time. @@ -7596,9 +7599,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 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 + // 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}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -10412,9 +10415,12 @@ 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. -// This feature is only available for users who have Retail Search -// enabled. Please enable Retail Search on Cloud Console before using -// this feature. +// 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10519,7 +10525,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. 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. 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.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -10570,9 +10576,13 @@ 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. 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. 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10677,7 +10687,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. 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. 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.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -11917,9 +11927,12 @@ 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. -// This feature is only available for users who have Retail Search -// enabled. Please enable Retail Search on Cloud Console before using -// this feature. +// 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12024,7 +12037,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. 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. 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.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -12073,9 +12086,13 @@ 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. 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. 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12180,7 +12197,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. 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. 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.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -12241,9 +12258,13 @@ type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct { // 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. +// 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. // // - name: Immutable. Full resource name of the product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12346,7 +12367,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. 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. 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.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -13363,7 +13384,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)) @@ -13470,7 +13491,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" // }, @@ -13508,7 +13529,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 { @@ -13612,7 +13633,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, @@ -13840,12 +13861,12 @@ type ProjectsLocationsCatalogsModelsPatchCall struct { } // Patch: 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. +// updated are: `filtering_option` and `periodic_tuning_state`. If other +// values are provided, this API method ignores 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)} @@ -13855,8 +13876,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, will by default -// update all fields. +// fields in the provided 'model' to update. If not set, by default +// updates all fields. func (c *ProjectsLocationsCatalogsModelsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsCatalogsModelsPatchCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -13953,7 +13974,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, periodic_tuning_state. If other values are provided, this API method will ignore them.", + // "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.", // "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}", // "httpMethod": "PATCH", // "id": "retail.projects.locations.catalogs.models.patch", @@ -13962,14 +13983,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, will by default update all fields.", + // "description": "Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -16745,10 +16766,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 { @@ -16849,7 +16870,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 887dba5742e..94fd3424619 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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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. 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. 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.", "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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "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 Cosole 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 Console 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', `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`, and `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. e.g. 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. For example, 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 (in case the model fails at serving time, we can fall back to the default)." + "description": "Required. The default candidate. If the model fails at serving time, we 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 / may be used for PAGE_OPTIMIZATION recommendations.", + "description": "Represents an ordered combination of valid serving configs, which can 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. format.", + "description": "Google Cloud Storage location for input content.", "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 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}`.", + "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}`.", "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 will be 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 are 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 will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is 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 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}`.", + "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}`.", "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 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.", + "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.", "type": "string" }, "reconciliationMode": { @@ -3705,7 +3705,7 @@ "type": "string" }, "updateMask": { - "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", + "description": "Indicates which fields in the provided imported `products` to update. If not set, all fields are updated.", "format": "google-fieldmask", "type": "string" } diff --git a/retail/v2beta/retail-gen.go b/retail/v2beta/retail-gen.go index b6aa09deb17..9169317a0a6 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 will be + // 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. 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 will be returned by the +// of the Import operation. This is 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 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 + // 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}`. 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 will be + // 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. 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 will be returned by the +// progress of the Import operation. This is 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 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 + // 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}`. 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,10 +1440,11 @@ type GoogleCloudRetailV2alphaModel struct { // DisplayName: 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. + // Console 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: @@ -1462,8 +1463,8 @@ type GoogleCloudRetailV2alphaModel struct { // Name: 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. + // `projects/{project_number}/locations/{location_id}/catalogs/{catalog_i + // d}/models/{model_id}` catalog_id has char limit of 50. // recommendation_model_id has char limit of 40. Name string `json:"name,omitempty"` @@ -1480,19 +1481,20 @@ 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"` @@ -1500,23 +1502,24 @@ 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. @@ -1531,8 +1534,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', `recently-viewed`(readonly value). + // `frequently-bought-together`, `page-optimization`, `similar-items`, + // `buy-it-again`, and `recently-viewed`(readonly value). Type string `json:"type,omitempty"` // UpdateTime: Output only. Timestamp the Recommendation Model was last @@ -1609,21 +1612,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, @@ -1636,7 +1639,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) @@ -1676,10 +1679,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. - // e.g. for a ServingConfig with full name: + // ServingConfigId: This has to be a valid ServingConfig identifier. For + // example, 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 @@ -1713,8 +1716,8 @@ type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct { // = 10. Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"` - // DefaultCandidate: Required. The default candidate (in case the model - // fails at serving time, we can fall back to the default). + // DefaultCandidate: Required. The default candidate. If the model fails + // at serving time, we fall back to the default. DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"` // DisplayName: Optional. The name to display for the panel. @@ -1744,11 +1747,11 @@ func (s *GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel) MarshalJSON() } // GoogleCloudRetailV2alphaModelServingConfigList: Represents an ordered -// combination of valid serving configs, which / may be used for -// PAGE_OPTIMIZATION recommendations. +// combination of valid serving configs, which can 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 @@ -3531,7 +3534,7 @@ func (s *GoogleCloudRetailV2betaFulfillmentInfo) MarshalJSON() ([]byte, error) { } // GoogleCloudRetailV2betaGcsSource: Google Cloud Storage location for -// input content. format. +// input content. type GoogleCloudRetailV2betaGcsSource struct { // DataSchema: The schema to use when parsing the data from the source. // Supported values for product imports: * `product` (default): One JSON @@ -3542,9 +3545,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 @@ -3671,9 +3674,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 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 + // 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}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -3737,7 +3740,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 will be + // 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. GcsPrefix string `json:"gcsPrefix,omitempty"` @@ -3766,7 +3769,7 @@ func (s *GoogleCloudRetailV2betaImportErrorsConfig) MarshalJSON() ([]byte, error } // GoogleCloudRetailV2betaImportMetadata: Metadata related to the -// progress of the Import operation. This will be returned by the +// progress of the Import operation. This is returned by the // google.longrunning.Operation.metadata field. type GoogleCloudRetailV2betaImportMetadata struct { // CreateTime: Operation create time. @@ -3777,9 +3780,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 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 + // 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}`. NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"` @@ -3828,9 +3831,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 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 + // 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. @@ -3852,7 +3855,7 @@ type GoogleCloudRetailV2betaImportProductsRequest struct { RequestId string `json:"requestId,omitempty"` // UpdateMask: Indicates which fields in the provided imported - // 'products' to update. If not set, will by default update all fields. + // `products` to update. If not set, all fields are updated. UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorsConfig") to @@ -10256,9 +10259,12 @@ 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. -// This feature is only available for users who have Retail Search -// enabled. Please enable Retail Search on Cloud Console before using -// this feature. +// 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10363,7 +10369,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. 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. 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.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces", @@ -10414,9 +10420,13 @@ 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. 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. 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -10521,7 +10531,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. 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. 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.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.addLocalInventories", @@ -11594,9 +11604,12 @@ 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. -// This feature is only available for users who have Retail Search -// enabled. Please enable Retail Search on Cloud Console before using -// this feature. +// 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -11701,7 +11714,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. 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. 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.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces", @@ -11750,9 +11763,13 @@ 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. 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. 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. // // - product: Full resource name of Product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -11857,7 +11874,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. 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. 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.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.removeLocalInventories", @@ -11918,9 +11935,13 @@ type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct { // 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. +// 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. // // - name: Immutable. Full resource name of the product, such as // `projects/*/locations/global/catalogs/default_catalog/branches/defau @@ -12023,7 +12044,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. 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. 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.", // "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory", // "httpMethod": "POST", // "id": "retail.projects.locations.catalogs.branches.products.setInventory", @@ -15340,10 +15361,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 { @@ -15444,7 +15465,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",