From 1c49aed1f23a37f07eb9726aa26ceeecbd1f5fca Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Thu, 18 Aug 2022 07:12:59 +0000 Subject: [PATCH] feat(all): auto-regenerate discovery clients --- admin/directory/v1/admin-api.json | 17 +- admin/directory/v1/admin-gen.go | 38 +- adsense/v2/adsense-api.json | 42 +- adsense/v2/adsense-gen.go | 191 +++ .../v1alpha/analyticsadmin-api.json | 20 +- analyticsadmin/v1alpha/analyticsadmin-gen.go | 13 +- apigateway/v1beta/apigateway-api.json | 4 +- apigateway/v1beta/apigateway-gen.go | 22 +- appengine/v1/appengine-api.json | 6 +- appengine/v1/appengine-gen.go | 11 +- dataproc/v1/dataproc-api.json | 7 +- dataproc/v1/dataproc-gen.go | 13 +- .../v0.alpha/deploymentmanager-api.json | 4 +- .../v0.alpha/deploymentmanager-gen.go | 22 +- .../v2/deploymentmanager-api.json | 4 +- deploymentmanager/v2/deploymentmanager-gen.go | 22 +- .../v2beta/deploymentmanager-api.json | 4 +- .../v2beta/deploymentmanager-gen.go | 22 +- drive/v2/drive-api.json | 12 +- drive/v2/drive-gen.go | 12 + drive/v3/drive-api.json | 12 +- drive/v3/drive-gen.go | 12 + gkehub/v1alpha/gkehub-api.json | 50 +- gkehub/v1alpha/gkehub-gen.go | 91 +- healthcare/v1/healthcare-api.json | 6 +- healthcare/v1/healthcare-gen.go | 63 +- healthcare/v1beta1/healthcare-api.json | 6 +- healthcare/v1beta1/healthcare-gen.go | 46 +- identitytoolkit/v2/identitytoolkit-api.json | 34 +- identitytoolkit/v2/identitytoolkit-gen.go | 73 +- .../v1alpha1/managedidentities-api.json | 18 +- .../v1alpha1/managedidentities-gen.go | 46 +- ml/v1/ml-api.json | 4 +- ml/v1/ml-gen.go | 22 +- playintegrity/v1/playintegrity-api.json | 33 +- playintegrity/v1/playintegrity-gen.go | 56 +- retail/v2/retail-api.json | 84 +- retail/v2/retail-gen.go | 207 +-- retail/v2alpha/retail-api.json | 96 +- retail/v2alpha/retail-gen.go | 235 +-- retail/v2beta/retail-api.json | 84 +- retail/v2beta/retail-gen.go | 207 +-- run/v1/run-api.json | 523 +++---- run/v1/run-gen.go | 1339 ++++++++--------- searchconsole/v1/searchconsole-api.json | 12 +- searchconsole/v1/searchconsole-gen.go | 15 +- secretmanager/v1/secretmanager-api.json | 11 +- secretmanager/v1/secretmanager-gen.go | 43 +- secretmanager/v1beta1/secretmanager-api.json | 4 +- secretmanager/v1beta1/secretmanager-gen.go | 22 +- .../v1/serviceconsumermanagement-api.json | 6 +- .../v1/serviceconsumermanagement-gen.go | 24 +- .../serviceconsumermanagement-api.json | 6 +- .../v1beta1/serviceconsumermanagement-gen.go | 24 +- .../v1/servicenetworking-api.json | 6 +- servicenetworking/v1/servicenetworking-gen.go | 24 +- .../v1beta/servicenetworking-api.json | 6 +- .../v1beta/servicenetworking-gen.go | 24 +- serviceusage/v1/serviceusage-api.json | 6 +- serviceusage/v1/serviceusage-gen.go | 24 +- serviceusage/v1beta1/serviceusage-api.json | 6 +- serviceusage/v1beta1/serviceusage-gen.go | 24 +- transcoder/v1/transcoder-api.json | 63 +- transcoder/v1/transcoder-gen.go | 122 ++ 64 files changed, 2462 insertions(+), 1843 deletions(-) diff --git a/admin/directory/v1/admin-api.json b/admin/directory/v1/admin-api.json index 33442a54dbc..6107a240a9b 100644 --- a/admin/directory/v1/admin-api.json +++ b/admin/directory/v1/admin-api.json @@ -493,7 +493,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the Google Workspace account", + "description": "Immutable. ID of the Google Workspace account", "location": "path", "required": true, "type": "string" @@ -626,13 +626,13 @@ ], "parameters": { "customerId": { - "description": "Immutable. Immutable ID of the Google Workspace account.", + "description": "Immutable. ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" }, "deviceId": { - "description": "Immutable. Immutable ID of Chrome OS Device.", + "description": "Immutable. ID of Chrome OS Device.", "location": "path", "required": true, "type": "string" @@ -665,20 +665,20 @@ ], "parameters": { "commandId": { - "description": "Immutable. Immutable ID of Chrome OS Device Command.", + "description": "Immutable. ID of Chrome OS Device Command.", "format": "int64", "location": "path", "required": true, "type": "string" }, "customerId": { - "description": "Immutable. Immutable ID of the Google Workspace account.", + "description": "Immutable. ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" }, "deviceId": { - "description": "Immutable. Immutable ID of Chrome OS Device.", + "description": "Immutable. ID of Chrome OS Device.", "location": "path", "required": true, "type": "string" @@ -1648,7 +1648,7 @@ ] }, "hasMember": { - "description": "Checks whether the given user is a member of the group. Membership can be direct or nested.", + "description": "Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.", "flatPath": "admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}", "httpMethod": "GET", "id": "directory.members.hasMember", @@ -4407,7 +4407,7 @@ } } }, - "revision": "20220809", + "revision": "20220816", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5333,6 +5333,7 @@ "type": "object" }, "ChromeOsDeviceAction": { + "description": "The data regarding an action to update the status of a Chrome OS device.", "id": "ChromeOsDeviceAction", "properties": { "action": { diff --git a/admin/directory/v1/admin-gen.go b/admin/directory/v1/admin-gen.go index 79797bf305c..62af1d8edf9 100644 --- a/admin/directory/v1/admin-gen.go +++ b/admin/directory/v1/admin-gen.go @@ -2071,6 +2071,8 @@ func (s *ChromeOsDeviceTpmVersionInfo) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ChromeOsDeviceAction: The data regarding an action to update the +// status of a Chrome OS device. type ChromeOsDeviceAction struct { // Action: Action to be taken on the Chrome OS device. Action string `json:"action,omitempty"` @@ -7073,7 +7075,7 @@ type ChromeosdevicesMoveDevicesToOuCall struct { // MoveDevicesToOu: Moves or inserts multiple Chrome OS devices to an // organizational unit. You can move up to 50 devices at once. // -// - customerId: Immutable ID of the Google Workspace account. +// - customerId: Immutable. ID of the Google Workspace account. // - orgUnitPath: Full path of the target organizational unit or its ID. func (r *ChromeosdevicesService) MoveDevicesToOu(customerId string, orgUnitPath string, chromeosmovedevicestoou *ChromeOsMoveDevicesToOu) *ChromeosdevicesMoveDevicesToOuCall { c := &ChromeosdevicesMoveDevicesToOuCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -7159,7 +7161,7 @@ func (c *ChromeosdevicesMoveDevicesToOuCall) Do(opts ...googleapi.CallOption) er // ], // "parameters": { // "customerId": { - // "description": "Immutable ID of the Google Workspace account", + // "description": "Immutable. ID of the Google Workspace account", // "location": "path", // "required": true, // "type": "string" @@ -7573,9 +7575,8 @@ type CustomerDevicesChromeosIssueCommandCall struct { // IssueCommand: Issues a command for the device to execute. // -// - customerId: Immutable. Immutable ID of the Google Workspace -// account. -// - deviceId: Immutable. Immutable ID of Chrome OS Device. +// - customerId: Immutable. ID of the Google Workspace account. +// - deviceId: Immutable. ID of Chrome OS Device. func (r *CustomerDevicesChromeosService) IssueCommand(customerId string, deviceId string, directorychromeosdevicesissuecommandrequest *DirectoryChromeosdevicesIssueCommandRequest) *CustomerDevicesChromeosIssueCommandCall { c := &CustomerDevicesChromeosIssueCommandCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.customerId = customerId @@ -7688,13 +7689,13 @@ func (c *CustomerDevicesChromeosIssueCommandCall) Do(opts ...googleapi.CallOptio // ], // "parameters": { // "customerId": { - // "description": "Immutable. Immutable ID of the Google Workspace account.", + // "description": "Immutable. ID of the Google Workspace account.", // "location": "path", // "required": true, // "type": "string" // }, // "deviceId": { - // "description": "Immutable. Immutable ID of Chrome OS Device.", + // "description": "Immutable. ID of Chrome OS Device.", // "location": "path", // "required": true, // "type": "string" @@ -7729,10 +7730,9 @@ type CustomerDevicesChromeosCommandsGetCall struct { // Get: Gets command data a specific command issued to the device. // -// - commandId: Immutable. Immutable ID of Chrome OS Device Command. -// - customerId: Immutable. Immutable ID of the Google Workspace -// account. -// - deviceId: Immutable. Immutable ID of Chrome OS Device. +// - commandId: Immutable. ID of Chrome OS Device Command. +// - customerId: Immutable. ID of the Google Workspace account. +// - deviceId: Immutable. ID of Chrome OS Device. func (r *CustomerDevicesChromeosCommandsService) Get(customerId string, deviceId string, commandId int64) *CustomerDevicesChromeosCommandsGetCall { c := &CustomerDevicesChromeosCommandsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.customerId = customerId @@ -7853,20 +7853,20 @@ func (c *CustomerDevicesChromeosCommandsGetCall) Do(opts ...googleapi.CallOption // ], // "parameters": { // "commandId": { - // "description": "Immutable. Immutable ID of Chrome OS Device Command.", + // "description": "Immutable. ID of Chrome OS Device Command.", // "format": "int64", // "location": "path", // "required": true, // "type": "string" // }, // "customerId": { - // "description": "Immutable. Immutable ID of the Google Workspace account.", + // "description": "Immutable. ID of the Google Workspace account.", // "location": "path", // "required": true, // "type": "string" // }, // "deviceId": { - // "description": "Immutable. Immutable ID of Chrome OS Device.", + // "description": "Immutable. ID of Chrome OS Device.", // "location": "path", // "required": true, // "type": "string" @@ -12412,7 +12412,13 @@ type MembersHasMemberCall struct { } // HasMember: Checks whether the given user is a member of the group. -// Membership can be direct or nested. +// Membership can be direct or nested, but if nested, the `memberKey` +// and `groupKey` must be entities in the same domain or an `Invalid +// input` error is returned. To check for nested memberships that +// include entities outside of the group's domain, use the +// `checkTransitiveMembership()` +// (https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) +// method in the Cloud Identity Groups API. // // - groupKey: Identifies the group in the API request. The value can be // the group's email address, group alias, or the unique group ID. @@ -12525,7 +12531,7 @@ func (c *MembersHasMemberCall) Do(opts ...googleapi.CallOption) (*MembersHasMemb } return ret, nil // { - // "description": "Checks whether the given user is a member of the group. Membership can be direct or nested.", + // "description": "Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.", // "flatPath": "admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}", // "httpMethod": "GET", // "id": "directory.members.hasMember", diff --git a/adsense/v2/adsense-api.json b/adsense/v2/adsense-api.json index e21bfb44a8c..891c5955261 100644 --- a/adsense/v2/adsense-api.json +++ b/adsense/v2/adsense-api.json @@ -134,6 +134,31 @@ "https://www.googleapis.com/auth/adsense.readonly" ] }, + "getAdBlockingRecoveryTag": { + "description": "Gets the ad blocking recovery tag of an account.", + "flatPath": "v2/accounts/{accountsId}/adBlockingRecoveryTag", + "httpMethod": "GET", + "id": "adsense.accounts.getAdBlockingRecoveryTag", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the account to get the tag for. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}/adBlockingRecoveryTag", + "response": { + "$ref": "AdBlockingRecoveryTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, "list": { "description": "Lists all accounts available to this user.", "flatPath": "v2/accounts", @@ -1645,7 +1670,7 @@ } } }, - "revision": "20220810", + "revision": "20220817", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { @@ -1705,6 +1730,21 @@ }, "type": "object" }, + "AdBlockingRecoveryTag": { + "description": "Representation of an ad blocking recovery tag. See https://support.google.com/adsense/answer/11575177.", + "id": "AdBlockingRecoveryTag", + "properties": { + "errorProtectionCode": { + "description": "Error protection code that can be used in conjunction with the tag. It'll display a message to users if an [ad blocking extension blocks their access to your site](https://support.google.com/adsense/answer/11575480).", + "type": "string" + }, + "tag": { + "description": "The ad blocking recovery tag. Note that the message generated by the tag can be blocked by an ad blocking extension. If this is not your desired outcome, then you'll need to use it in conjunction with the error protection code.", + "type": "string" + } + }, + "type": "object" + }, "AdClient": { "description": "Representation of an ad client. An ad client represents a user's subscription with a specific AdSense product.", "id": "AdClient", diff --git a/adsense/v2/adsense-gen.go b/adsense/v2/adsense-gen.go index b73b4d72863..e7ba42ce276 100644 --- a/adsense/v2/adsense-gen.go +++ b/adsense/v2/adsense-gen.go @@ -323,6 +323,49 @@ func (s *Account) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AdBlockingRecoveryTag: Representation of an ad blocking recovery tag. +// See https://support.google.com/adsense/answer/11575177. +type AdBlockingRecoveryTag struct { + // ErrorProtectionCode: Error protection code that can be used in + // conjunction with the tag. It'll display a message to users if an ad + // blocking extension blocks their access to your site + // (https://support.google.com/adsense/answer/11575480). + ErrorProtectionCode string `json:"errorProtectionCode,omitempty"` + + // Tag: The ad blocking recovery tag. Note that the message generated by + // the tag can be blocked by an ad blocking extension. If this is not + // your desired outcome, then you'll need to use it in conjunction with + // the error protection code. + Tag string `json:"tag,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "ErrorProtectionCode") + // 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. "ErrorProtectionCode") 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 *AdBlockingRecoveryTag) MarshalJSON() ([]byte, error) { + type NoMethod AdBlockingRecoveryTag + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AdClient: Representation of an ad client. An ad client represents a // user's subscription with a specific AdSense product. type AdClient struct { @@ -1723,6 +1766,154 @@ func (c *AccountsGetCall) Do(opts ...googleapi.CallOption) (*Account, error) { } +// method id "adsense.accounts.getAdBlockingRecoveryTag": + +type AccountsGetAdBlockingRecoveryTagCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetAdBlockingRecoveryTag: Gets the ad blocking recovery tag of an +// account. +// +// - name: The name of the account to get the tag for. Format: +// accounts/{account}. +func (r *AccountsService) GetAdBlockingRecoveryTag(name string) *AccountsGetAdBlockingRecoveryTagCall { + c := &AccountsGetAdBlockingRecoveryTagCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *AccountsGetAdBlockingRecoveryTagCall) Fields(s ...googleapi.Field) *AccountsGetAdBlockingRecoveryTagCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *AccountsGetAdBlockingRecoveryTagCall) IfNoneMatch(entityTag string) *AccountsGetAdBlockingRecoveryTagCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *AccountsGetAdBlockingRecoveryTagCall) Context(ctx context.Context) *AccountsGetAdBlockingRecoveryTagCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *AccountsGetAdBlockingRecoveryTagCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsGetAdBlockingRecoveryTagCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}/adBlockingRecoveryTag") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "adsense.accounts.getAdBlockingRecoveryTag" call. +// Exactly one of *AdBlockingRecoveryTag or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *AdBlockingRecoveryTag.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *AccountsGetAdBlockingRecoveryTagCall) Do(opts ...googleapi.CallOption) (*AdBlockingRecoveryTag, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, &googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + } + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, err + } + ret := &AdBlockingRecoveryTag{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the ad blocking recovery tag of an account.", + // "flatPath": "v2/accounts/{accountsId}/adBlockingRecoveryTag", + // "httpMethod": "GET", + // "id": "adsense.accounts.getAdBlockingRecoveryTag", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The name of the account to get the tag for. Format: accounts/{account}", + // "location": "path", + // "pattern": "^accounts/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+name}/adBlockingRecoveryTag", + // "response": { + // "$ref": "AdBlockingRecoveryTag" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/adsense" + // ] + // } + +} + // method id "adsense.accounts.list": type AccountsListCall struct { diff --git a/analyticsadmin/v1alpha/analyticsadmin-api.json b/analyticsadmin/v1alpha/analyticsadmin-api.json index dff1cf3e16a..0d0d18b851f 100644 --- a/analyticsadmin/v1alpha/analyticsadmin-api.json +++ b/analyticsadmin/v1alpha/analyticsadmin-api.json @@ -1081,7 +1081,7 @@ ] }, "get": { - "description": "Lookup for a single Audience. Audiences created before 2020 may not be supported.", + "description": "Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.", "flatPath": "v1alpha/properties/{propertiesId}/audiences/{audiencesId}", "httpMethod": "GET", "id": "analyticsadmin.properties.audiences.get", @@ -1107,7 +1107,7 @@ ] }, "list": { - "description": "Lists Audiences on a property. Audiences created before 2020 may not be supported.", + "description": "Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.", "flatPath": "v1alpha/properties/{propertiesId}/audiences", "httpMethod": "GET", "id": "analyticsadmin.properties.audiences.list", @@ -2802,7 +2802,7 @@ } } }, - "revision": "20220803", + "revision": "20220817", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -3484,17 +3484,13 @@ "OPERATION_UNSPECIFIED", "EQUAL", "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL" + "GREATER_THAN" ], "enumDescriptions": [ "Unspecified.", "Equal.", "Less than.", - "Less than or equal.", - "Greater than.", - "Greater than or equal." + "Greater than." ], "type": "string" }, @@ -3538,8 +3534,7 @@ "BEGINS_WITH", "ENDS_WITH", "CONTAINS", - "FULL_REGEXP", - "PARTIAL_REGEXP" + "FULL_REGEXP" ], "enumDescriptions": [ "Unspecified", @@ -3547,8 +3542,7 @@ "Begins with the string value.", "Ends with the string value.", "Contains the string value.", - "Full regular expression matches with the string value.", - "Partial regular expression matches with the string value." + "Full regular expression matches with the string value." ], "type": "string" }, diff --git a/analyticsadmin/v1alpha/analyticsadmin-gen.go b/analyticsadmin/v1alpha/analyticsadmin-gen.go index a6bb4519e6b..03174786c1d 100644 --- a/analyticsadmin/v1alpha/analyticsadmin-gen.go +++ b/analyticsadmin/v1alpha/analyticsadmin-gen.go @@ -1556,9 +1556,7 @@ type GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter str // "OPERATION_UNSPECIFIED" - Unspecified. // "EQUAL" - Equal. // "LESS_THAN" - Less than. - // "LESS_THAN_OR_EQUAL" - Less than or equal. // "GREATER_THAN" - Greater than. - // "GREATER_THAN_OR_EQUAL" - Greater than or equal. Operation string `json:"operation,omitempty"` // Value: Required. The numeric or date value to match against. @@ -1651,8 +1649,6 @@ type GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter stru // "CONTAINS" - Contains the string value. // "FULL_REGEXP" - Full regular expression matches with the string // value. - // "PARTIAL_REGEXP" - Partial regular expression matches with the - // string value. MatchType string `json:"matchType,omitempty"` // Value: Required. The string value to be matched against. @@ -10003,7 +9999,7 @@ type PropertiesAudiencesGetCall struct { } // Get: Lookup for a single Audience. Audiences created before 2020 may -// not be supported. +// not be supported. Default audiences will not show filter definitions. // // - name: The name of the Audience to get. Example format: // properties/1234/audiences/5678. @@ -10113,7 +10109,7 @@ func (c *PropertiesAudiencesGetCall) Do(opts ...googleapi.CallOption) (*GoogleAn } return ret, nil // { - // "description": "Lookup for a single Audience. Audiences created before 2020 may not be supported.", + // "description": "Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.", // "flatPath": "v1alpha/properties/{propertiesId}/audiences/{audiencesId}", // "httpMethod": "GET", // "id": "analyticsadmin.properties.audiences.get", @@ -10153,7 +10149,8 @@ type PropertiesAudiencesListCall struct { } // List: Lists Audiences on a property. Audiences created before 2020 -// may not be supported. +// may not be supported. Default audiences will not show filter +// definitions. // // - parent: Example format: properties/1234. func (r *PropertiesAudiencesService) List(parent string) *PropertiesAudiencesListCall { @@ -10282,7 +10279,7 @@ func (c *PropertiesAudiencesListCall) Do(opts ...googleapi.CallOption) (*GoogleA } return ret, nil // { - // "description": "Lists Audiences on a property. Audiences created before 2020 may not be supported.", + // "description": "Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.", // "flatPath": "v1alpha/properties/{propertiesId}/audiences", // "httpMethod": "GET", // "id": "analyticsadmin.properties.audiences.list", diff --git a/apigateway/v1beta/apigateway-api.json b/apigateway/v1beta/apigateway-api.json index e6e8d8c7588..2255d907175 100644 --- a/apigateway/v1beta/apigateway-api.json +++ b/apigateway/v1beta/apigateway-api.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220504", + "revision": "20220811", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1351,7 +1351,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/v1beta/apigateway-gen.go b/apigateway/v1beta/apigateway-gen.go index 301529fb299..74aa6bde0a8 100644 --- a/apigateway/v1beta/apigateway-gen.go +++ b/apigateway/v1beta/apigateway-gen.go @@ -630,16 +630,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/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json index 8cdf5b5e8ad..5f761cee024 100644 --- a/appengine/v1/appengine-api.json +++ b/appengine/v1/appengine-api.json @@ -1595,11 +1595,11 @@ } } }, - "revision": "20220612", + "revision": "20220813", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { - "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", + "description": "Cloud Endpoints (https://cloud.google.com/endpoints/) configuration for API handlers.", "id": "ApiConfigHandler", "properties": { "authFailAction": { @@ -3494,7 +3494,7 @@ "properties": { "apiConfig": { "$ref": "ApiConfigHandler", - "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set." + "description": "Serving configuration for Cloud Endpoints (https://cloud.google.com/endpoints/).Only returned in GET requests if view=FULL is set." }, "appEngineApis": { "description": "Allows App Engine second generation runtimes to access the legacy bundled services.", diff --git a/appengine/v1/appengine-gen.go b/appengine/v1/appengine-gen.go index 5a4d5acd2a4..1947b6e0579 100644 --- a/appengine/v1/appengine-gen.go +++ b/appengine/v1/appengine-gen.go @@ -279,9 +279,8 @@ type AppsServicesVersionsInstancesService struct { s *APIService } -// ApiConfigHandler: Google Cloud Endpoints -// (https://cloud.google.com/appengine/docs/python/endpoints/) -// configuration for API handlers. +// ApiConfigHandler: Cloud Endpoints +// (https://cloud.google.com/endpoints/) configuration for API handlers. type ApiConfigHandler struct { // AuthFailAction: Action to take when users access resources that // require authentication. Defaults to redirect. @@ -3472,9 +3471,9 @@ func (s *UrlMap) MarshalJSON() ([]byte, error) { // Version: A Version resource is a specific set of source code and // configuration files that are deployed into a service. type Version struct { - // ApiConfig: Serving configuration for Google Cloud Endpoints - // (https://cloud.google.com/appengine/docs/python/endpoints/).Only - // returned in GET requests if view=FULL is set. + // ApiConfig: Serving configuration for Cloud Endpoints + // (https://cloud.google.com/endpoints/).Only returned in GET requests + // if view=FULL is set. ApiConfig *ApiConfigHandler `json:"apiConfig,omitempty"` // AppEngineApis: Allows App Engine second generation runtimes to access diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json index 0b909452809..ee66a0ceec4 100644 --- a/dataproc/v1/dataproc-api.json +++ b/dataproc/v1/dataproc-api.json @@ -2444,7 +2444,7 @@ } } }, - "revision": "20220804", + "revision": "20220814", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3250,6 +3250,11 @@ "description": "Execution configuration for a workload.", "id": "ExecutionConfig", "properties": { + "idleTtl": { + "description": "Optional. The duration to keep the underlying cluster alive while idling Passing this threshold will cause the cluster to be terminated. Minimum value is 30 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", + "format": "google-duration", + "type": "string" + }, "kmsKey": { "description": "Optional. The Cloud KMS key to use for encryption.", "type": "string" diff --git a/dataproc/v1/dataproc-gen.go b/dataproc/v1/dataproc-gen.go index 5b1f758214e..ed8cdbef53e 100644 --- a/dataproc/v1/dataproc-gen.go +++ b/dataproc/v1/dataproc-gen.go @@ -1542,6 +1542,13 @@ func (s *EnvironmentConfig) MarshalJSON() ([]byte, error) { // ExecutionConfig: Execution configuration for a workload. type ExecutionConfig struct { + // IdleTtl: Optional. The duration to keep the underlying cluster alive + // while idling Passing this threshold will cause the cluster to be + // terminated. Minimum value is 30 minutes; maximum value is 14 days + // (see JSON representation of Duration + // (https://developers.google.com/protocol-buffers/docs/proto3#json)). + IdleTtl string `json:"idleTtl,omitempty"` + // KmsKey: Optional. The Cloud KMS key to use for encryption. KmsKey string `json:"kmsKey,omitempty"` @@ -1558,7 +1565,7 @@ type ExecutionConfig struct { // SubnetworkUri: Optional. Subnetwork URI to connect workload to. SubnetworkUri string `json:"subnetworkUri,omitempty"` - // ForceSendFields is a list of field names (e.g. "KmsKey") to + // ForceSendFields is a list of field names (e.g. "IdleTtl") 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 @@ -1566,8 +1573,8 @@ type ExecutionConfig struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "KmsKey") to include in API - // requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "IdleTtl") 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. diff --git a/deploymentmanager/v0.alpha/deploymentmanager-api.json b/deploymentmanager/v0.alpha/deploymentmanager-api.json index 5b02d5f313e..67012eac457 100644 --- a/deploymentmanager/v0.alpha/deploymentmanager-api.json +++ b/deploymentmanager/v0.alpha/deploymentmanager-api.json @@ -1588,7 +1588,7 @@ } } }, - "revision": "20220714", + "revision": "20220811", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1702,7 +1702,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/deploymentmanager/v0.alpha/deploymentmanager-gen.go b/deploymentmanager/v0.alpha/deploymentmanager-gen.go index df3cba80b4d..6dc7289e824 100644 --- a/deploymentmanager/v0.alpha/deploymentmanager-gen.go +++ b/deploymentmanager/v0.alpha/deploymentmanager-gen.go @@ -457,16 +457,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/deploymentmanager/v2/deploymentmanager-api.json b/deploymentmanager/v2/deploymentmanager-api.json index b1663763dda..9a157e4b76a 100644 --- a/deploymentmanager/v2/deploymentmanager-api.json +++ b/deploymentmanager/v2/deploymentmanager-api.json @@ -988,7 +988,7 @@ } } }, - "revision": "20220714", + "revision": "20220811", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1048,7 +1048,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/deploymentmanager/v2/deploymentmanager-gen.go b/deploymentmanager/v2/deploymentmanager-gen.go index 695dbf07588..5d9b1e452e7 100644 --- a/deploymentmanager/v2/deploymentmanager-gen.go +++ b/deploymentmanager/v2/deploymentmanager-gen.go @@ -330,16 +330,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/deploymentmanager/v2beta/deploymentmanager-api.json b/deploymentmanager/v2beta/deploymentmanager-api.json index 3de5f362726..422e1e30d29 100644 --- a/deploymentmanager/v2beta/deploymentmanager-api.json +++ b/deploymentmanager/v2beta/deploymentmanager-api.json @@ -1552,7 +1552,7 @@ } } }, - "revision": "20220714", + "revision": "20220811", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1666,7 +1666,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/deploymentmanager/v2beta/deploymentmanager-gen.go b/deploymentmanager/v2beta/deploymentmanager-gen.go index bcab22a410f..3468fde76e1 100644 --- a/deploymentmanager/v2beta/deploymentmanager-gen.go +++ b/deploymentmanager/v2beta/deploymentmanager-gen.go @@ -457,16 +457,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/drive/v2/drive-api.json b/drive/v2/drive-api.json index 062d654f3f2..8b979aec1a5 100644 --- a/drive/v2/drive-api.json +++ b/drive/v2/drive-api.json @@ -38,7 +38,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/yvf5HwkC5GNTy86jNm4Q9l2g6tw\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/Pp29cn2zOwAam8Wlmn7HNXRwCW0\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -3668,7 +3668,7 @@ } } }, - "revision": "20220709", + "revision": "20220815", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -5337,6 +5337,14 @@ "description": "A link back to this file.", "type": "string" }, + "sha1Checksum": { + "description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", + "type": "string" + }, + "sha256Checksum": { + "description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", + "type": "string" + }, "shareable": { "description": "Deprecated: use capabilities/canShare.", "type": "boolean" diff --git a/drive/v2/drive-gen.go b/drive/v2/drive-gen.go index 3ae730bcab9..1b04d3a1312 100644 --- a/drive/v2/drive-gen.go +++ b/drive/v2/drive-gen.go @@ -2165,6 +2165,18 @@ type File struct { // SelfLink: A link back to this file. SelfLink string `json:"selfLink,omitempty"` + // Sha1Checksum: The SHA1 checksum associated with this file, if + // available. This field is only populated for files with content stored + // in Google Drive; it is not populated for Docs Editors or shortcut + // files. + Sha1Checksum string `json:"sha1Checksum,omitempty"` + + // Sha256Checksum: The SHA256 checksum associated with this file, if + // available. This field is only populated for files with content stored + // in Google Drive; it is not populated for Docs Editors or shortcut + // files. + Sha256Checksum string `json:"sha256Checksum,omitempty"` + // Shareable: Deprecated: use capabilities/canShare. Shareable bool `json:"shareable,omitempty"` diff --git a/drive/v3/drive-api.json b/drive/v3/drive-api.json index 55999ba85f5..6211bb54eee 100644 --- a/drive/v3/drive-api.json +++ b/drive/v3/drive-api.json @@ -35,7 +35,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/w7NrSVvAsjGozhSi_2XXg55ifjM\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/WveG9q_CVnWogOpzbn8ICFVS5lc\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -2312,7 +2312,7 @@ } } }, - "revision": "20220709", + "revision": "20220815", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3412,6 +3412,14 @@ "description": "A key needed to access the item via a shared link.", "type": "string" }, + "sha1Checksum": { + "description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", + "type": "string" + }, + "sha256Checksum": { + "description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", + "type": "string" + }, "shared": { "description": "Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" diff --git a/drive/v3/drive-gen.go b/drive/v3/drive-gen.go index be1fc423b0d..41803b7683d 100644 --- a/drive/v3/drive-gen.go +++ b/drive/v3/drive-gen.go @@ -1387,6 +1387,18 @@ type File struct { // ResourceKey: A key needed to access the item via a shared link. ResourceKey string `json:"resourceKey,omitempty"` + // Sha1Checksum: The SHA1 checksum associated with this file, if + // available. This field is only populated for files with content stored + // in Google Drive; it is not populated for Docs Editors or shortcut + // files. + Sha1Checksum string `json:"sha1Checksum,omitempty"` + + // Sha256Checksum: The SHA256 checksum associated with this file, if + // available. This field is only populated for files with content stored + // in Google Drive; it is not populated for Docs Editors or shortcut + // files. + Sha256Checksum string `json:"sha256Checksum,omitempty"` + // Shared: Whether the file has been shared. Not populated for items in // shared drives. Shared bool `json:"shared,omitempty"` diff --git a/gkehub/v1alpha/gkehub-api.json b/gkehub/v1alpha/gkehub-api.json index 36aa74a47ec..264356c0060 100644 --- a/gkehub/v1alpha/gkehub-api.json +++ b/gkehub/v1alpha/gkehub-api.json @@ -1151,7 +1151,7 @@ } } }, - "revision": "20220805", + "revision": "20220812", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2605,14 +2605,6 @@ "description": "Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.", "id": "IdentityServiceAuthMethod", "properties": { - "azureadConfig": { - "$ref": "IdentityServiceAzureADConfig", - "description": "AzureAD specific Configuration." - }, - "googleConfig": { - "$ref": "IdentityServiceGoogleConfig", - "description": "GoogleConfig specific configuration" - }, "name": { "description": "Identifier for auth config.", "type": "string" @@ -2628,46 +2620,6 @@ }, "type": "object" }, - "IdentityServiceAzureADConfig": { - "description": "Configuration for the AzureAD Auth flow.", - "id": "IdentityServiceAzureADConfig", - "properties": { - "clientId": { - "description": "ID for the registered client application that makes authentication requests to the Azure AD identity provider.", - "type": "string" - }, - "clientSecret": { - "description": "Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.", - "type": "string" - }, - "encryptedClientSecret": { - "description": "Output only. Encrypted AzureAD client secret.", - "format": "byte", - "readOnly": true, - "type": "string" - }, - "kubectlRedirectUri": { - "description": "The redirect URL that kubectl uses for authorization.", - "type": "string" - }, - "tenant": { - "description": "Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.", - "type": "string" - } - }, - "type": "object" - }, - "IdentityServiceGoogleConfig": { - "description": "Configuration for the Google Plugin Auth flow.", - "id": "IdentityServiceGoogleConfig", - "properties": { - "disable": { - "description": "Disable automatic configuration of Google Plugin on supported platforms.", - "type": "boolean" - } - }, - "type": "object" - }, "IdentityServiceMembershipSpec": { "description": "**Anthos Identity Service**: Configuration for a single Membership.", "id": "IdentityServiceMembershipSpec", diff --git a/gkehub/v1alpha/gkehub-gen.go b/gkehub/v1alpha/gkehub-gen.go index 040de8c4fae..29447228e80 100644 --- a/gkehub/v1alpha/gkehub-gen.go +++ b/gkehub/v1alpha/gkehub-gen.go @@ -2638,12 +2638,6 @@ func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error) { // member/cluster. Only one authentication method (e.g., OIDC and LDAP) // can be set per AuthMethod. type IdentityServiceAuthMethod struct { - // AzureadConfig: AzureAD specific Configuration. - AzureadConfig *IdentityServiceAzureADConfig `json:"azureadConfig,omitempty"` - - // GoogleConfig: GoogleConfig specific configuration - GoogleConfig *IdentityServiceGoogleConfig `json:"googleConfig,omitempty"` - // Name: Identifier for auth config. Name string `json:"name,omitempty"` @@ -2653,7 +2647,7 @@ type IdentityServiceAuthMethod struct { // Proxy: Proxy server address to use for auth method. Proxy string `json:"proxy,omitempty"` - // ForceSendFields is a list of field names (e.g. "AzureadConfig") to + // ForceSendFields is a list of field names (e.g. "Name") 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 @@ -2661,83 +2655,8 @@ type IdentityServiceAuthMethod struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AzureadConfig") 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 *IdentityServiceAuthMethod) MarshalJSON() ([]byte, error) { - type NoMethod IdentityServiceAuthMethod - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// IdentityServiceAzureADConfig: Configuration for the AzureAD Auth -// flow. -type IdentityServiceAzureADConfig struct { - // ClientId: ID for the registered client application that makes - // authentication requests to the Azure AD identity provider. - ClientId string `json:"clientId,omitempty"` - - // ClientSecret: Input only. Unencrypted AzureAD client secret will be - // passed to the GKE Hub CLH. - ClientSecret string `json:"clientSecret,omitempty"` - - // EncryptedClientSecret: Output only. Encrypted AzureAD client secret. - EncryptedClientSecret string `json:"encryptedClientSecret,omitempty"` - - // KubectlRedirectUri: The redirect URL that kubectl uses for - // authorization. - KubectlRedirectUri string `json:"kubectlRedirectUri,omitempty"` - - // Tenant: Kind of Azure AD account to be authenticated. Supported - // values are or for accounts belonging to a specific tenant. - Tenant string `json:"tenant,omitempty"` - - // ForceSendFields is a list of field names (e.g. "ClientId") 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. "ClientId") 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 *IdentityServiceAzureADConfig) MarshalJSON() ([]byte, error) { - type NoMethod IdentityServiceAzureADConfig - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// IdentityServiceGoogleConfig: Configuration for the Google Plugin Auth -// flow. -type IdentityServiceGoogleConfig struct { - // Disable: Disable automatic configuration of Google Plugin on - // supported platforms. - Disable bool `json:"disable,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Disable") 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. "Disable") to include in - // API requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "Name") 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. @@ -2745,8 +2664,8 @@ type IdentityServiceGoogleConfig struct { NullFields []string `json:"-"` } -func (s *IdentityServiceGoogleConfig) MarshalJSON() ([]byte, error) { - type NoMethod IdentityServiceGoogleConfig +func (s *IdentityServiceAuthMethod) MarshalJSON() ([]byte, error) { + type NoMethod IdentityServiceAuthMethod raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } diff --git a/healthcare/v1/healthcare-api.json b/healthcare/v1/healthcare-api.json index 211aca49e4a..d41e4ad2373 100644 --- a/healthcare/v1/healthcare-api.json +++ b/healthcare/v1/healthcare-api.json @@ -3127,7 +3127,7 @@ ] }, "executeBundle": { - "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", + "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", @@ -4053,7 +4053,7 @@ } } }, - "revision": "20220629", + "revision": "20220810", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -4267,7 +4267,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/healthcare/v1/healthcare-gen.go b/healthcare/v1/healthcare-gen.go index 45bac99ebd3..6f613069c18 100644 --- a/healthcare/v1/healthcare-gen.go +++ b/healthcare/v1/healthcare-gen.go @@ -743,16 +743,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, @@ -20717,35 +20721,44 @@ type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall struct { // ExecuteBundle: Executes all the requests in the given Bundle. // Implements the FHIR standard batch/transaction interaction (DSTU2 -// (http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), +// (https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), // STU3 -// (http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), +// (https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), // R4 -// (http://hl7.org/implement/standards/fhir/R4/http.html#transaction)). +// (https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). // Supports all interactions within a bundle, except search. This method // accepts Bundles of type `batch` and `transaction`, processing them // according to the batch processing rules (DSTU2 -// (http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), +// (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), // STU3 -// (http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), -// R4 (http://hl7.org/implement/standards/fhir/R4/http.html#brules)) and -// transaction processing rules (DSTU2 -// (http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), +// (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), +// R4 (https://hl7.org/implement/standards/fhir/R4/http.html#brules)) +// and transaction processing rules (DSTU2 +// (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), // STU3 -// (http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), -// R4 (http://hl7.org/implement/standards/fhir/R4/http.html#trules)). +// (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), +// R4 (https://hl7.org/implement/standards/fhir/R4/http.html#trules)). // The request body must contain a JSON-encoded FHIR `Bundle` resource, // and the request headers must contain `Content-Type: // application/fhir+json`. For a batch bundle or a successful -// transaction the response body will contain a JSON-encoded -// representation of a `Bundle` resource of type `batch-response` or +// transaction, the response body contains a JSON-encoded representation +// of a `Bundle` resource of type `batch-response` or // `transaction-response` containing one entry for each entry in the // request, with the outcome of processing the entry. In the case of an -// error for a transaction bundle, the response body will contain a +// error for a transaction bundle, the response body contains a // JSON-encoded `OperationOutcome` resource describing the reason for // the error. If the request cannot be mapped to a valid API method on a -// FHIR store, a generic GCP error might be returned instead. For -// samples that show how to call `executeBundle`, see Managing FHIR +// FHIR store, a generic GCP error might be returned instead. This +// method checks permissions for each request in the bundle. The +// `executeBundle` permission is required to call this method, but you +// must also grant sufficient permissions to execute the individual +// requests in the bundle. For example, if the bundle contains a request +// to create a FHIR resource, the caller must also have been granted the +// `healthcare.fhirResources.create` permission. You can use audit logs +// to view the permissions for `executeBundle` and each request in the +// bundle. For more information, see Viewing Cloud Audit logs +// (https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). +// For samples that show how to call `executeBundle`, see Managing FHIR // resources using FHIR bundles (/healthcare/docs/how-tos/fhir-bundles). // // - parent: Name of the FHIR store in which this bundle will be @@ -20809,7 +20822,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Do(opts ...go gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", + // "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", diff --git a/healthcare/v1beta1/healthcare-api.json b/healthcare/v1beta1/healthcare-api.json index e4a3dfe1da2..91d732cd252 100644 --- a/healthcare/v1beta1/healthcare-api.json +++ b/healthcare/v1beta1/healthcare-api.json @@ -3887,7 +3887,7 @@ ] }, "executeBundle": { - "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires permission for executing the requests in the bundle. The `executeBundle` permission grants permission to execute the request in the bundle but you must grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a `create` request, you must have permission to execute the `create` request. Logging is available for the `executeBundle` permission. For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", + "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", @@ -4865,7 +4865,7 @@ } } }, - "revision": "20220629", + "revision": "20220810", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5171,7 +5171,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/healthcare/v1beta1/healthcare-gen.go b/healthcare/v1beta1/healthcare-gen.go index bef525881da..0edc3d53cb8 100644 --- a/healthcare/v1beta1/healthcare-gen.go +++ b/healthcare/v1beta1/healthcare-gen.go @@ -972,16 +972,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, @@ -25878,7 +25882,7 @@ type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall struct { // The request body must contain a JSON-encoded FHIR `Bundle` resource, // and the request headers must contain `Content-Type: // application/fhir+json`. For a batch bundle or a successful -// transaction the response body contains a JSON-encoded representation +// transaction, the response body contains a JSON-encoded representation // of a `Bundle` resource of type `batch-response` or // `transaction-response` containing one entry for each entry in the // request, with the outcome of processing the entry. In the case of an @@ -25886,15 +25890,17 @@ type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall struct { // JSON-encoded `OperationOutcome` resource describing the reason for // the error. If the request cannot be mapped to a valid API method on a // FHIR store, a generic GCP error might be returned instead. This -// method requires permission for executing the requests in the bundle. -// The `executeBundle` permission grants permission to execute the -// request in the bundle but you must grant sufficient permissions to -// execute the individual requests in the bundle. For example, if the -// bundle contains a `create` request, you must have permission to -// execute the `create` request. Logging is available for the -// `executeBundle` permission. For samples that show how to call -// `executeBundle`, see Managing FHIR resources using FHIR bundles -// (/healthcare/docs/how-tos/fhir-bundles). +// method checks permissions for each request in the bundle. The +// `executeBundle` permission is required to call this method, but you +// must also grant sufficient permissions to execute the individual +// requests in the bundle. For example, if the bundle contains a request +// to create a FHIR resource, the caller must also have been granted the +// `healthcare.fhirResources.create` permission. You can use audit logs +// to view the permissions for `executeBundle` and each request in the +// bundle. For more information, see Viewing Cloud Audit logs +// (https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). +// For samples that show how to call `executeBundle`, see Managing FHIR +// resources using FHIR bundles (/healthcare/docs/how-tos/fhir-bundles). // // - parent: Name of the FHIR store in which this bundle will be // executed. @@ -25957,7 +25963,7 @@ func (c *ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Do(opts ...go gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires permission for executing the requests in the bundle. The `executeBundle` permission grants permission to execute the request in the bundle but you must grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a `create` request, you must have permission to execute the `create` request. Logging is available for the `executeBundle` permission. For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", + // "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", diff --git a/identitytoolkit/v2/identitytoolkit-api.json b/identitytoolkit/v2/identitytoolkit-api.json index 0e8939e7d6d..04bfc5acb0e 100644 --- a/identitytoolkit/v2/identitytoolkit-api.json +++ b/identitytoolkit/v2/identitytoolkit-api.json @@ -17,7 +17,7 @@ "canonicalName": "Identity Toolkit", "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryVersion": "v1", - "documentationLink": "https://firebase.google.com/docs/auth/", + "documentationLink": "https://cloud.google.com/identity-platform", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1527,7 +1527,7 @@ } } }, - "revision": "20220806", + "revision": "20220815", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2Anonymous": { @@ -1597,6 +1597,32 @@ }, "type": "object" }, + "GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig": { + "description": "Options related to how clients making requests on behalf of a tenant should be configured.", + "id": "GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig", + "properties": { + "permissions": { + "$ref": "GoogleCloudIdentitytoolkitAdminV2ClientPermissions", + "description": "Configuration related to restricting a user's ability to affect their account." + } + }, + "type": "object" + }, + "GoogleCloudIdentitytoolkitAdminV2ClientPermissions": { + "description": "Configuration related to restricting a user's ability to affect their account.", + "id": "GoogleCloudIdentitytoolkitAdminV2ClientPermissions", + "properties": { + "disabledUserDeletion": { + "description": "When true, end users cannot delete their account on the associated project through any of our API methods", + "type": "boolean" + }, + "disabledUserSignup": { + "description": "When true, end users cannot sign up for a new account on the associated project through any of our API methods", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig": { "description": "Additional config for Apple for code flow.", "id": "GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig", @@ -2501,6 +2527,10 @@ "description": "Whether anonymous users will be auto-deleted after a period of 30 days.", "type": "boolean" }, + "client": { + "$ref": "GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig", + "description": "Options related to how clients making requests on behalf of a project should be configured." + }, "disableAuth": { "description": "Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.", "type": "boolean" diff --git a/identitytoolkit/v2/identitytoolkit-gen.go b/identitytoolkit/v2/identitytoolkit-gen.go index 03c3ab5a543..e195e66e7b3 100644 --- a/identitytoolkit/v2/identitytoolkit-gen.go +++ b/identitytoolkit/v2/identitytoolkit-gen.go @@ -6,7 +6,7 @@ // Package identitytoolkit provides access to the Identity Toolkit API. // -// For product documentation, see: https://firebase.google.com/docs/auth/ +// For product documentation, see: https://cloud.google.com/identity-platform // // # Creating a client // @@ -420,6 +420,73 @@ func (s *GoogleCloudIdentitytoolkitAdminV2ClientConfig) MarshalJSON() ([]byte, e return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig: Options +// related to how clients making requests on behalf of a tenant should +// be configured. +type GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig struct { + // Permissions: Configuration related to restricting a user's ability to + // affect their account. + Permissions *GoogleCloudIdentitytoolkitAdminV2ClientPermissions `json:"permissions,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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 *GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleCloudIdentitytoolkitAdminV2ClientPermissions: Configuration +// related to restricting a user's ability to affect their account. +type GoogleCloudIdentitytoolkitAdminV2ClientPermissions struct { + // DisabledUserDeletion: When true, end users cannot delete their + // account on the associated project through any of our API methods + DisabledUserDeletion bool `json:"disabledUserDeletion,omitempty"` + + // DisabledUserSignup: When true, end users cannot sign up for a new + // account on the associated project through any of our API methods + DisabledUserSignup bool `json:"disabledUserSignup,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DisabledUserDeletion") 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. "DisabledUserDeletion") 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 *GoogleCloudIdentitytoolkitAdminV2ClientPermissions) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudIdentitytoolkitAdminV2ClientPermissions + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig: Additional config // for Apple for code flow. type GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig struct { @@ -1922,6 +1989,10 @@ type GoogleCloudIdentitytoolkitAdminV2Tenant struct { // auto-deleted after a period of 30 days. AutodeleteAnonymousUsers bool `json:"autodeleteAnonymousUsers,omitempty"` + // Client: Options related to how clients making requests on behalf of a + // project should be configured. + Client *GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig `json:"client,omitempty"` + // DisableAuth: Whether authentication is disabled for the tenant. If // true, the users under the disabled tenant are not allowed to sign-in. // Admins of the disabled tenant are not able to manage its users. diff --git a/managedidentities/v1alpha1/managedidentities-api.json b/managedidentities/v1alpha1/managedidentities-api.json index c0c72093810..ac4163079df 100644 --- a/managedidentities/v1alpha1/managedidentities-api.json +++ b/managedidentities/v1alpha1/managedidentities-api.json @@ -1403,7 +1403,7 @@ } } }, - "revision": "20220526", + "revision": "20220816", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -1501,7 +1501,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" }, @@ -1905,7 +1905,7 @@ "additionalProperties": { "type": "string" }, - "description": "Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", + "description": "Optional. Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", "type": "object" }, "maintenanceSchedules": { @@ -2045,7 +2045,7 @@ "additionalProperties": { "$ref": "MaintenancePolicy" }, - "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.", + "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed, then only populate MaintenancePolicy.name.", "type": "object" } }, @@ -2915,12 +2915,18 @@ "enum": [ "UPDATE_CHANNEL_UNSPECIFIED", "EARLIER", - "LATER" + "LATER", + "WEEK1", + "WEEK2", + "WEEK5" ], "enumDescriptions": [ "Unspecified channel.", "Early channel within a customer project.", - "Later channel within a customer project." + "Later channel within a customer project.", + "! ! The follow channels can ONLY be used if you adopt the new MW system! ! ! NOTE: all WEEK channels are assumed to be under a weekly window. ! There is currently no dedicated channel definitions for Daily windows. ! If you use Daily window, the system will assume a 1d (24Hours) advanced ! notification period b/w EARLY and LATER. ! We may consider support more flexible daily channel specifications in ! the future. WEEK1 == EARLIER with minimum 7d advanced notification. {7d, 14d} The system will treat them equally and will use WEEK1 whenever it can. New customers are encouraged to use this channel annotation.", + "WEEK2 == LATER with minimum 14d advanced notification {14d, 21d}.", + "WEEK5 == 40d support. minimum 35d advanced notification {35d, 42d}." ], "type": "string" }, diff --git a/managedidentities/v1alpha1/managedidentities-gen.go b/managedidentities/v1alpha1/managedidentities-gen.go index 030015a3887..3e1292706c3 100644 --- a/managedidentities/v1alpha1/managedidentities-gen.go +++ b/managedidentities/v1alpha1/managedidentities-gen.go @@ -349,16 +349,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, @@ -982,9 +986,9 @@ type GoogleCloudSaasacceleratorManagementProvidersV1Instance struct { // value are arbitrary strings provided by the user. Labels map[string]string `json:"labels,omitempty"` - // MaintenancePolicyNames: Deprecated. The MaintenancePolicies that have - // been attached to the instance. The key must be of the type name of - // the oneof policy name defined in MaintenancePolicy, and the + // MaintenancePolicyNames: Optional. Deprecated. The MaintenancePolicies + // that have been attached to the instance. The key must be of the type + // name of the oneof policy name defined in MaintenancePolicy, and the // referenced policy must define the same policy type. For complete // details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. MaintenancePolicyNames map[string]string `json:"maintenancePolicyNames,omitempty"` @@ -1155,9 +1159,7 @@ type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings struct { // oneof policy name defined in MaintenancePolicy, and the embedded // policy must define the same policy type. For complete details of // MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the - // name is needed (like in the deprecated - // Instance.maintenance_policy_names field) then only populate - // MaintenancePolicy.name. + // name is needed, then only populate MaintenancePolicy.name. MaintenancePolicies map[string]MaintenancePolicy `json:"maintenancePolicies,omitempty"` // ForceSendFields is a list of field names (e.g. "Exclude") to @@ -2634,6 +2636,20 @@ type UpdatePolicy struct { // "UPDATE_CHANNEL_UNSPECIFIED" - Unspecified channel. // "EARLIER" - Early channel within a customer project. // "LATER" - Later channel within a customer project. + // "WEEK1" - ! ! The follow channels can ONLY be used if you adopt the + // new MW system! ! ! NOTE: all WEEK channels are assumed to be under a + // weekly window. ! There is currently no dedicated channel definitions + // for Daily windows. ! If you use Daily window, the system will assume + // a 1d (24Hours) advanced ! notification period b/w EARLY and LATER. ! + // We may consider support more flexible daily channel specifications in + // ! the future. WEEK1 == EARLIER with minimum 7d advanced notification. + // {7d, 14d} The system will treat them equally and will use WEEK1 + // whenever it can. New customers are encouraged to use this channel + // annotation. + // "WEEK2" - WEEK2 == LATER with minimum 14d advanced notification + // {14d, 21d}. + // "WEEK5" - WEEK5 == 40d support. minimum 35d advanced notification + // {35d, 42d}. Channel string `json:"channel,omitempty"` // DenyMaintenancePeriods: Deny Maintenance Period that is applied to diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json index 391cb35fcd5..dd22ac2c1e3 100644 --- a/ml/v1/ml-api.json +++ b/ml/v1/ml-api.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20220520", + "revision": "20220812", "rootUrl": "https://ml.googleapis.com/", "schemas": { "GoogleApi__HttpBody": { @@ -3705,7 +3705,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/ml/v1/ml-gen.go b/ml/v1/ml-gen.go index 150dc1ad88a..7197d2b1323 100644 --- a/ml/v1/ml-gen.go +++ b/ml/v1/ml-gen.go @@ -4268,16 +4268,20 @@ type GoogleIamV1__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/playintegrity/v1/playintegrity-api.json b/playintegrity/v1/playintegrity-api.json index fb22d498c7b..cd9d7cc633c 100644 --- a/playintegrity/v1/playintegrity-api.json +++ b/playintegrity/v1/playintegrity-api.json @@ -138,13 +138,17 @@ } } }, - "revision": "20220315", + "revision": "20220816", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountDetails": { "description": "Contains the account information such as the licensing status for the user in the scope.", "id": "AccountDetails", "properties": { + "accountRiskVerdict": { + "$ref": "AccountRiskVerdict", + "description": "Details about the account risk for the user in the scope. This feature is available only to selected developers." + }, "appLicensingVerdict": { "description": "Required. Details about the licensing status of the user for the app in the scope.", "enum": [ @@ -164,6 +168,33 @@ }, "type": "object" }, + "AccountRiskVerdict": { + "description": "Contains information about account risk that indicates if the current user session seems low risk, unknown, or risky before you allow important actions to proceed.", + "id": "AccountRiskVerdict", + "properties": { + "riskLevel": { + "description": "Required. Indicates the account risk level of the current user session.", + "enum": [ + "RISK_LEVEL_UNSPECIFIED", + "RISK_LEVEL_UNEVALUATED", + "RISK_LEVEL_RISK", + "RISK_LEVEL_UNKNOWN", + "RISK_LEVEL_LOW_RISK", + "RISK_LEVEL_LOWEST_RISK" + ], + "enumDescriptions": [ + "Risk level has not been set.", + "The account risk is not evaluated, because the device is not trusted or the user does not have a Play app license.", + "Play thinks that at least one of the user accounts on the device has some unusual store engagement behavior that could be risky.", + "Play does not have sufficient information to assess the risk. The account may be new, or it may lack activity on the Play Store.", + "Play thinks the user could be genuine, since there is some store engagement. However, some signals to support the trust level are missing.", + "Play thinks the user is more likely to be genuine due to harder to replicate store engagement signals." + ], + "type": "string" + } + }, + "type": "object" + }, "AppIntegrity": { "description": "Contains the application integrity information.", "id": "AppIntegrity", diff --git a/playintegrity/v1/playintegrity-gen.go b/playintegrity/v1/playintegrity-gen.go index 8d8c0ea1ff5..38d4ed6f221 100644 --- a/playintegrity/v1/playintegrity-gen.go +++ b/playintegrity/v1/playintegrity-gen.go @@ -148,6 +148,10 @@ type V1Service struct { // AccountDetails: Contains the account information such as the // licensing status for the user in the scope. type AccountDetails struct { + // AccountRiskVerdict: Details about the account risk for the user in + // the scope. This feature is available only to selected developers. + AccountRiskVerdict *AccountRiskVerdict `json:"accountRiskVerdict,omitempty"` + // AppLicensingVerdict: Required. Details about the licensing status of // the user for the app in the scope. // @@ -163,7 +167,7 @@ type AccountDetails struct { // meet the minimum bar or the application was not a known Play version. AppLicensingVerdict string `json:"appLicensingVerdict,omitempty"` - // ForceSendFields is a list of field names (e.g. "AppLicensingVerdict") + // ForceSendFields is a list of field names (e.g. "AccountRiskVerdict") // 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 @@ -171,7 +175,7 @@ type AccountDetails struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AppLicensingVerdict") to + // NullFields is a list of field names (e.g. "AccountRiskVerdict") 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 @@ -187,6 +191,54 @@ func (s *AccountDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// AccountRiskVerdict: Contains information about account risk that +// indicates if the current user session seems low risk, unknown, or +// risky before you allow important actions to proceed. +type AccountRiskVerdict struct { + // RiskLevel: Required. Indicates the account risk level of the current + // user session. + // + // Possible values: + // "RISK_LEVEL_UNSPECIFIED" - Risk level has not been set. + // "RISK_LEVEL_UNEVALUATED" - The account risk is not evaluated, + // because the device is not trusted or the user does not have a Play + // app license. + // "RISK_LEVEL_RISK" - Play thinks that at least one of the user + // accounts on the device has some unusual store engagement behavior + // that could be risky. + // "RISK_LEVEL_UNKNOWN" - Play does not have sufficient information to + // assess the risk. The account may be new, or it may lack activity on + // the Play Store. + // "RISK_LEVEL_LOW_RISK" - Play thinks the user could be genuine, + // since there is some store engagement. However, some signals to + // support the trust level are missing. + // "RISK_LEVEL_LOWEST_RISK" - Play thinks the user is more likely to + // be genuine due to harder to replicate store engagement signals. + RiskLevel string `json:"riskLevel,omitempty"` + + // ForceSendFields is a list of field names (e.g. "RiskLevel") 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. "RiskLevel") 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 *AccountRiskVerdict) MarshalJSON() ([]byte, error) { + type NoMethod AccountRiskVerdict + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AppIntegrity: Contains the application integrity information. type AppIntegrity struct { // AppRecognitionVerdict: Required. Details about the app recognition 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", diff --git a/run/v1/run-api.json b/run/v1/run-api.json index b52e5646622..3a5ce724a4d 100644 --- a/run/v1/run-api.json +++ b/run/v1/run-api.json @@ -159,7 +159,7 @@ ], "parameters": { "name": { - "description": "The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + "description": "The name of the configuration to retrieve. For Cloud Run, replace {namespace_id} with the project ID or number.", "location": "path", "pattern": "^namespaces/[^/]+/configurations/[^/]+$", "required": true, @@ -189,12 +189,12 @@ "type": "string" }, "fieldSelector": { - "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "boolean" }, @@ -204,25 +204,25 @@ "type": "string" }, "limit": { - "description": "Optional. The maximum number of records that should be returned.", + "description": "Optional. The maximum number of the records that should be returned.", "format": "int32", "location": "query", "type": "integer" }, "parent": { - "description": "The namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + "description": "The namespace from which the configurations should be listed. For Cloud Run, replace {namespace_id} with the project ID or number.", "location": "path", "pattern": "^namespaces/[^/]+$", "required": true, "type": "string" }, "resourceVersion": { - "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "boolean" } @@ -304,7 +304,7 @@ "type": "string" }, "propagationPolicy": { - "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", "location": "query", "type": "string" } @@ -343,7 +343,7 @@ ] }, "list": { - "description": "List domain mappings.", + "description": "List all domain mappings.", "flatPath": "apis/domains.cloudrun.com/v1/namespaces/{namespacesId}/domainmappings", "httpMethod": "GET", "id": "run.namespaces.domainmappings.list", @@ -462,7 +462,7 @@ "type": "string" }, "propagationPolicy": { - "description": "Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see http://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", "location": "query", "type": "string" } @@ -515,12 +515,12 @@ "type": "string" }, "fieldSelector": { - "description": "Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Optional. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "boolean" }, @@ -530,7 +530,7 @@ "type": "string" }, "limit": { - "description": "Optional. The maximum number of records that should be returned.", + "description": "Optional. The maximum number of the records that should be returned.", "format": "int32", "location": "query", "type": "integer" @@ -543,12 +543,12 @@ "type": "string" }, "resourceVersion": { - "description": "Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "boolean" } @@ -673,12 +673,12 @@ "type": "string" }, "fieldSelector": { - "description": "Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Optional. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "boolean" }, @@ -701,12 +701,12 @@ "type": "string" }, "resourceVersion": { - "description": "Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "boolean" } @@ -729,7 +729,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the service being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "Required. The name of the job being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", "location": "path", "pattern": "^namespaces/[^/]+/jobs/[^/]+$", "required": true, @@ -811,7 +811,7 @@ "type": "string" }, "propagationPolicy": { - "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see https://kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", "location": "query", "type": "string" } @@ -1005,7 +1005,7 @@ "services": { "methods": { "create": { - "description": "Create a service.", + "description": "Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.", "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services", "httpMethod": "POST", "id": "run.namespaces.services.create", @@ -1019,7 +1019,7 @@ "type": "string" }, "parent": { - "description": "The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The resource's parent. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", "location": "path", "pattern": "^namespaces/[^/]+$", "required": true, @@ -1038,7 +1038,7 @@ ] }, "delete": { - "description": "Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.", + "description": "Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.", "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services/{servicesId}", "httpMethod": "DELETE", "id": "run.namespaces.services.delete", @@ -1047,7 +1047,7 @@ ], "parameters": { "apiVersion": { - "description": "Cloud Run currently ignores this parameter.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, @@ -1057,19 +1057,19 @@ "type": "string" }, "kind": { - "description": "Cloud Run currently ignores this parameter.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, "name": { - "description": "The name of the service to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The fully qualified name of the service to delete. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", "location": "path", "pattern": "^namespaces/[^/]+/services/[^/]+$", "required": true, "type": "string" }, "propagationPolicy": { - "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" } @@ -1083,7 +1083,7 @@ ] }, "get": { - "description": "Get information about a service.", + "description": "Gets information about a service.", "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services/{servicesId}", "httpMethod": "GET", "id": "run.namespaces.services.get", @@ -1092,7 +1092,7 @@ ], "parameters": { "name": { - "description": "The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The fully qualified name of the service to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", "location": "path", "pattern": "^namespaces/[^/]+/services/[^/]+$", "required": true, @@ -1108,7 +1108,7 @@ ] }, "list": { - "description": "List services.", + "description": "Lists services for the given project and region.", "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services", "httpMethod": "GET", "id": "run.namespaces.services.list", @@ -1122,12 +1122,12 @@ "type": "string" }, "fieldSelector": { - "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "boolean" }, @@ -1143,19 +1143,19 @@ "type": "integer" }, "parent": { - "description": "The namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", "location": "path", "pattern": "^namespaces/[^/]+$", "required": true, "type": "string" }, "resourceVersion": { - "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "boolean" } @@ -1169,7 +1169,7 @@ ] }, "replaceService": { - "description": "Replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", + "description": "Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services/{servicesId}", "httpMethod": "PUT", "id": "run.namespaces.services.replaceService", @@ -1183,7 +1183,7 @@ "type": "string" }, "name": { - "description": "The name of the service being replaced. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The fully qualified name of the service to replace. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", "location": "path", "pattern": "^namespaces/[^/]+/services/[^/]+$", "required": true, @@ -1245,12 +1245,12 @@ "type": "string" }, "fieldSelector": { - "description": "Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Optional. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "boolean" }, @@ -1273,12 +1273,12 @@ "type": "string" }, "resourceVersion": { - "description": "Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Optional. Not supported by Cloud Run.", "location": "query", "type": "boolean" } @@ -1434,7 +1434,7 @@ ], "parameters": { "name": { - "description": "The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + "description": "The name of the configuration to retrieve. For Cloud Run, replace {namespace_id} with the project ID or number.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/configurations/[^/]+$", "required": true, @@ -1464,12 +1464,12 @@ "type": "string" }, "fieldSelector": { - "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "boolean" }, @@ -1479,25 +1479,25 @@ "type": "string" }, "limit": { - "description": "Optional. The maximum number of records that should be returned.", + "description": "Optional. The maximum number of the records that should be returned.", "format": "int32", "location": "query", "type": "integer" }, "parent": { - "description": "The namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + "description": "The namespace from which the configurations should be listed. For Cloud Run, replace {namespace_id} with the project ID or number.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "resourceVersion": { - "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Not supported by Cloud Run.", "location": "query", "type": "boolean" } @@ -1579,7 +1579,7 @@ "type": "string" }, "propagationPolicy": { - "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", "location": "query", "type": "string" } @@ -1618,7 +1618,7 @@ ] }, "list": { - "description": "List domain mappings.", + "description": "List all domain mappings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/domainmappings", "httpMethod": "GET", "id": "run.projects.locations.domainmappings.list", @@ -1805,7 +1805,7 @@ "type": "string" }, "propagationPolicy": { - "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see https://kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", "location": "query", "type": "string" } @@ -1999,7 +1999,7 @@ "services": { "methods": { "create": { - "description": "Create a service.", + "description": "Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", "httpMethod": "POST", "id": "run.projects.locations.services.create", @@ -2013,7 +2013,7 @@ "type": "string" }, "parent": { - "description": "The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The resource's parent. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2032,7 +2032,7 @@ ] }, "delete": { - "description": "Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.", + "description": "Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "DELETE", "id": "run.projects.locations.services.delete", @@ -2041,7 +2041,7 @@ ], "parameters": { "apiVersion": { - "description": "Cloud Run currently ignores this parameter.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, @@ -2051,19 +2051,19 @@ "type": "string" }, "kind": { - "description": "Cloud Run currently ignores this parameter.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, "name": { - "description": "The name of the service to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The fully qualified name of the service to delete. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "required": true, "type": "string" }, "propagationPolicy": { - "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" } @@ -2077,7 +2077,7 @@ ] }, "get": { - "description": "Get information about a service.", + "description": "Gets information about a service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "GET", "id": "run.projects.locations.services.get", @@ -2086,7 +2086,7 @@ ], "parameters": { "name": { - "description": "The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The fully qualified name of the service to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "required": true, @@ -2102,7 +2102,7 @@ ] }, "getIamPolicy": { - "description": "Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.", + "description": "Gets the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy", "httpMethod": "GET", "id": "run.projects.locations.services.getIamPolicy", @@ -2133,7 +2133,7 @@ ] }, "list": { - "description": "List services.", + "description": "Lists services for the given project and region.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", "httpMethod": "GET", "id": "run.projects.locations.services.list", @@ -2147,12 +2147,12 @@ "type": "string" }, "fieldSelector": { - "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, "includeUninitialized": { - "description": "Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "boolean" }, @@ -2168,19 +2168,19 @@ "type": "integer" }, "parent": { - "description": "The namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "resourceVersion": { - "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "string" }, "watch": { - "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + "description": "Not supported, and ignored by Cloud Run.", "location": "query", "type": "boolean" } @@ -2194,7 +2194,7 @@ ] }, "replaceService": { - "description": "Replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", + "description": "Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "PUT", "id": "run.projects.locations.services.replaceService", @@ -2208,7 +2208,7 @@ "type": "string" }, "name": { - "description": "The name of the service being replaced. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + "description": "The fully qualified name of the service to replace. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "required": true, @@ -2289,7 +2289,7 @@ } } }, - "revision": "20220807", + "revision": "20220814", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -2394,7 +2394,7 @@ "type": "object" }, "ConfigMapEnvSource": { - "description": "Not supported by Cloud Run ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.", + "description": "Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.", "id": "ConfigMapEnvSource", "properties": { "localObjectReference": { @@ -2406,18 +2406,18 @@ "type": "string" }, "optional": { - "description": "(Optional) Specify whether the ConfigMap must be defined", + "description": "Specify whether the ConfigMap must be defined.", "type": "boolean" } }, "type": "object" }, "ConfigMapKeySelector": { - "description": "Not supported by Cloud Run Selects a key from a ConfigMap.", + "description": "Not supported by Cloud Run. Selects a key from a ConfigMap.", "id": "ConfigMapKeySelector", "properties": { "key": { - "description": "The key to select.", + "description": "Required. The key to select.", "type": "string" }, "localObjectReference": { @@ -2425,18 +2425,18 @@ "description": "This field should not be used directly as it is meant to be inlined directly into the message. Use the \"name\" field instead." }, "name": { - "description": "The ConfigMap to select from.", + "description": "Required. The ConfigMap to select from.", "type": "string" }, "optional": { - "description": "(Optional) Specify whether the ConfigMap or its key must be defined", + "description": "Specify whether the ConfigMap or its key must be defined", "type": "boolean" } }, "type": "object" }, "ConfigMapVolumeSource": { - "description": "Not supported by Cloud Run Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.", + "description": "Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.", "id": "ConfigMapVolumeSource", "properties": { "defaultMode": { @@ -2463,7 +2463,7 @@ "type": "object" }, "Configuration": { - "description": "Configuration represents the \"floating HEAD\" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The \"latest created\" revision's name is available under status, as is the \"latest ready\" revision's name. See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration", + "description": "Configuration represents the \"floating HEAD\" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The \"latest created\" revision's name is available under status, as is the \"latest ready\" revision's name. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#configuration", "id": "Configuration", "properties": { "apiVersion": { @@ -2505,14 +2505,14 @@ "id": "ConfigurationStatus", "properties": { "conditions": { - "description": "Conditions communicates information about ongoing/complete reconciliation processes that bring the \"spec\" inline with the observed state of the world.", + "description": "Conditions communicate information about ongoing/complete reconciliation processes that bring the \"spec\" inline with the observed state of the world.", "items": { "$ref": "GoogleCloudRunV1Condition" }, "type": "array" }, "latestCreatedRevisionName": { - "description": "LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, for that use LatestReadyRevisionName.", + "description": "LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, so for the latest ready revision, use LatestReadyRevisionName.", "type": "string" }, "latestReadyRevisionName": { @@ -2532,50 +2532,51 @@ "id": "Container", "properties": { "args": { - "description": "(Optional) Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", + "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "items": { "type": "string" }, "type": "array" }, "command": { + "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "items": { "type": "string" }, "type": "array" }, "env": { - "description": "(Optional) List of environment variables to set in the container.", + "description": "List of environment variables to set in the container.", "items": { "$ref": "EnvVar" }, "type": "array" }, "envFrom": { - "description": "(Optional) List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.", + "description": "Not supported by Cloud Run.", "items": { "$ref": "EnvFromSource" }, "type": "array" }, "image": { - "description": "Only supports containers from Google Container Registry or Artifact Registry URL of the Container image. More info: https://kubernetes.io/docs/concepts/containers/images", + "description": "Required. URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images", "type": "string" }, "imagePullPolicy": { - "description": "(Optional) Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images", + "description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images", "type": "string" }, "livenessProbe": { "$ref": "Probe", - "description": "(Optional) Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + "description": "Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "name": { - "description": "(Optional) Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names", + "description": "Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names", "type": "string" }, "ports": { - "description": "(Optional) List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.", + "description": "List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.", "items": { "$ref": "ContainerPort" }, @@ -2583,37 +2584,37 @@ }, "readinessProbe": { "$ref": "Probe", - "description": "(Optional) Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + "description": "Not supported by Cloud Run." }, "resources": { "$ref": "ResourceRequirements", - "description": "(Optional) Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + "description": "Compute Resources required by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" }, "securityContext": { "$ref": "SecurityContext", - "description": "(Optional) Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + "description": "Not supported by Cloud Run." }, "startupProbe": { "$ref": "Probe", - "description": "(Optional) Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + "description": "Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "terminationMessagePath": { - "description": "(Optional) Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log.", + "description": "Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log.", "type": "string" }, "terminationMessagePolicy": { - "description": "(Optional) Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.", + "description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.", "type": "string" }, "volumeMounts": { - "description": "(Optional) Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.", + "description": "Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.", "items": { "$ref": "VolumeMount" }, "type": "array" }, "workingDir": { - "description": "(Optional) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.", + "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.", "type": "string" } }, @@ -2624,16 +2625,16 @@ "id": "ContainerPort", "properties": { "containerPort": { - "description": "(Optional) Port number the container listens on. This must be a valid port number, 0 \u003c x \u003c 65536.", + "description": "Port number the container listens on. This must be a valid port number, 0 \u003c x \u003c 65536.", "format": "int32", "type": "integer" }, "name": { - "description": "(Optional) If specified, used to specify which protocol to use. Allowed values are \"http1\" and \"h2c\".", + "description": "If specified, used to specify which protocol to use. Allowed values are \"http1\" and \"h2c\".", "type": "string" }, "protocol": { - "description": "(Optional) Protocol for port. Must be \"TCP\". Defaults to \"TCP\".", + "description": "Protocol for port. Must be \"TCP\". Defaults to \"TCP\".", "type": "string" } }, @@ -2680,7 +2681,7 @@ "enumDescriptions": [ "", "Do not provision an HTTPS certificate.", - "Automatically provisions an HTTPS certificate via GoogleCA or LetsEncrypt." + "Automatically provisions an HTTPS certificate via GoogleCA." ], "type": "string" }, @@ -2723,27 +2724,27 @@ "type": "array" }, "url": { - "description": "Optional. Cloud Run fully managed: not supported Cloud Run on GKE: supported Holds the URL that will serve the traffic of the DomainMapping.", + "description": "Optional. Not supported by Cloud Run.", "type": "string" } }, "type": "object" }, "EnvFromSource": { - "description": "Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps", + "description": "Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps", "id": "EnvFromSource", "properties": { "configMapRef": { "$ref": "ConfigMapEnvSource", - "description": "(Optional) The ConfigMap to select from" + "description": "The ConfigMap to select from" }, "prefix": { - "description": "(Optional) An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", + "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", "type": "string" }, "secretRef": { "$ref": "SecretEnvSource", - "description": "(Optional) The Secret to select from" + "description": "The Secret to select from" } }, "type": "object" @@ -2753,16 +2754,16 @@ "id": "EnvVar", "properties": { "name": { - "description": "Name of the environment variable. Must be a C_IDENTIFIER.", + "description": "Required. Name of the environment variable. Must be a C_IDENTIFIER.", "type": "string" }, "value": { - "description": "(Optional) Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".", + "description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".", "type": "string" }, "valueFrom": { "$ref": "EnvVarSource", - "description": "(Optional) Source for the environment variable's value. Only supports secret_key_ref. Source for the environment variable's value. Cannot be used if value is not empty." + "description": "Source for the environment variable's value. Only supports secret_key_ref. Cannot be used if value is not empty." } }, "type": "object" @@ -2773,21 +2774,21 @@ "properties": { "configMapKeyRef": { "$ref": "ConfigMapKeySelector", - "description": "(Optional) Not supported by Cloud Run Selects a key of a ConfigMap." + "description": "Not supported by Cloud Run. Selects a key of a ConfigMap." }, "secretKeyRef": { "$ref": "SecretKeySelector", - "description": "(Optional) Selects a key (version) of a secret in Secret Manager." + "description": "Selects a key (version) of a secret in Secret Manager." } }, "type": "object" }, "ExecAction": { - "description": "Not supported by Cloud Run ExecAction describes a \"run in container\" action.", + "description": "Not supported by Cloud Run. ExecAction describes a \"run in container\" action.", "id": "ExecAction", "properties": { "command": { - "description": "(Optional) Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, @@ -2797,28 +2798,28 @@ "type": "object" }, "Execution": { - "description": "Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.", + "description": "Execution represents the configuration of a single execution. An execution is an immutable resource that references a container image which is run to completion.", "id": "Execution", "properties": { "apiVersion": { - "description": "Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional", + "description": "Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { - "description": "Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional", + "description": "Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "ObjectMeta", - "description": "Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional" + "description": "Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" }, "spec": { "$ref": "ExecutionSpec", - "description": "Optional. Specification of the desired behavior of an execution. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional" + "description": "Optional. Specification of the desired behavior of an execution. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" }, "status": { "$ref": "ExecutionStatus", - "description": "Output only. Current status of an execution. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional", + "description": "Output only. Current status of an execution. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "readOnly": true } }, @@ -2850,12 +2851,12 @@ "id": "ExecutionSpec", "properties": { "parallelism": { - "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. Must be \u003c= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism. +optional", + "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. Must be \u003c= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism.", "format": "int32", "type": "integer" }, "taskCount": { - "description": "Optional. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional", + "description": "Optional. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.", "format": "int32", "type": "integer" }, @@ -2867,28 +2868,28 @@ "type": "object" }, "ExecutionStatus": { - "description": "ExecutionStatus represents the current state of a Execution.", + "description": "ExecutionStatus represents the current state of an Execution.", "id": "ExecutionStatus", "properties": { "cancelledCount": { - "description": "Optional. The number of tasks which reached phase Cancelled. +optional", + "description": "Optional. The number of tasks which reached phase Cancelled.", "format": "int32", "type": "integer" }, "completionTime": { - "description": "Optional. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional", + "description": "Optional. Represents the time that the execution was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional", "format": "google-datetime", "type": "string" }, "conditions": { - "description": "Optional. The latest available observations of an execution's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional", + "description": "Optional. The latest available observations of an execution's current state.", "items": { "$ref": "GoogleCloudRunV1Condition" }, "type": "array" }, "failedCount": { - "description": "Optional. The number of tasks which reached phase Failed. +optional", + "description": "Optional. The number of tasks which reached phase Failed.", "format": "int32", "type": "integer" }, @@ -2902,22 +2903,22 @@ "type": "integer" }, "retriedCount": { - "description": "Optional. The number of tasks which have retried at least once. +optional", + "description": "Optional. The number of tasks which have retried at least once.", "format": "int32", "type": "integer" }, "runningCount": { - "description": "Optional. The number of actively running tasks. +optional", + "description": "Optional. The number of actively running tasks.", "format": "int32", "type": "integer" }, "startTime": { - "description": "Optional. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional", + "description": "Optional. Represents the time that the execution started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "format": "google-datetime", "type": "string" }, "succeededCount": { - "description": "Optional. The number of tasks which reached phase Succeeded. +optional", + "description": "Optional. The number of tasks which reached phase Succeeded.", "format": "int32", "type": "integer" } @@ -2979,7 +2980,7 @@ "type": "object" }, "GoogleCloudRunV1Condition": { - "description": "Condition defines a generic condition for a Resource.", + "description": "Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type \"Ready\" or \"Completed\" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.", "id": "GoogleCloudRunV1Condition", "properties": { "lastTransitionTime": { @@ -2992,11 +2993,11 @@ "type": "string" }, "reason": { - "description": "Optional. One-word CamelCase reason for the condition's last transition.", + "description": "Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.", "type": "string" }, "severity": { - "description": "Optional. How to interpret failures of this condition, one of Error, Warning, Info", + "description": "Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.", "type": "string" }, "status": { @@ -3004,7 +3005,7 @@ "type": "string" }, "type": { - "description": "type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * \"Ready\": True when the Resource is ready.", + "description": "type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * \"Ready\" or \"Completed\": True when the Resource is ready.", "type": "string" } }, @@ -3042,22 +3043,22 @@ "id": "HTTPGetAction", "properties": { "host": { - "description": "(Optional) Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.", + "description": "Not supported by Cloud Run.", "type": "string" }, "httpHeaders": { - "description": "(Optional) Custom headers to set in the request. HTTP allows repeated headers.", + "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "$ref": "HTTPHeader" }, "type": "array" }, "path": { - "description": "(Optional) Path to access on the HTTP server.", + "description": "Path to access on the HTTP server.", "type": "string" }, "scheme": { - "description": "(Optional) Scheme to use for connecting to the host. Defaults to HTTP.", + "description": "Not supported by Cloud Run.", "type": "string" } }, @@ -3079,28 +3080,28 @@ "type": "object" }, "Job": { - "description": "Job represents the configuration of a single job. A job an immutable resource that references a container image which is run to completion.", + "description": "Job represents the configuration of a single job, which references a container image which is run to completion.", "id": "Job", "properties": { "apiVersion": { - "description": "Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional", + "description": "Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { - "description": "Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional", + "description": "Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "ObjectMeta", - "description": "Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional" + "description": "Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" }, "spec": { "$ref": "JobSpec", - "description": "Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional" + "description": "Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" }, "status": { "$ref": "JobStatus", - "description": "Output only. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional", + "description": "Output only. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "readOnly": true } }, @@ -3122,7 +3123,7 @@ "id": "JobStatus", "properties": { "conditions": { - "description": "The latest available observations of a job's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/", + "description": "The latest available observations of a job's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/job/", "items": { "$ref": "GoogleCloudRunV1Condition" }, @@ -3334,19 +3335,19 @@ "type": "object" }, "ListMeta": { - "description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.", + "description": "Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta.", "id": "ListMeta", "properties": { "continue": { - "description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.", + "description": "Continuation token is a value emitted when the count of items is larger than the user/system limit. To retrieve the next page of items, pass the value of `continue` as the next request's `page_token`.", "type": "string" }, "resourceVersion": { - "description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional", + "description": "Opaque string that identifies the server's internal version of this object. It can be used by clients to determine when objects have changed. If the message is passed back to the server, it must be left unmodified. https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency", "type": "string" }, "selfLink": { - "description": "SelfLink is a URL representing this object. Populated by the system. Read-only. +optional", + "description": "URL representing this object.", "type": "string" } }, @@ -3423,7 +3424,7 @@ "id": "ListServicesResponse", "properties": { "apiVersion": { - "description": "The API version for this call such as \"serving.knative.dev/v1\".", + "description": "The API version for this call; returns \"serving.knative.dev/v1\".", "type": "string" }, "items": { @@ -3434,7 +3435,7 @@ "type": "array" }, "kind": { - "description": "The kind of this resource, in this case \"ServiceList\".", + "description": "The kind of this resource; returns \"ServiceList\".", "type": "string" }, "metadata": { @@ -3442,7 +3443,7 @@ "description": "Metadata associated with this Service list." }, "unreachable": { - "description": "Locations that could not be reached.", + "description": "For calls against the global endpoint, returns the list of Cloud locations that could not be reached. For regional calls, this field is not used.", "items": { "type": "string" }, @@ -3485,11 +3486,11 @@ "type": "object" }, "LocalObjectReference": { - "description": "Not supported by Cloud Run LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "description": "Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", "id": "LocalObjectReference", "properties": { "name": { - "description": "(Optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" } }, @@ -3537,41 +3538,41 @@ "additionalProperties": { "type": "string" }, - "description": "(Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", + "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. Execution. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" }, "clusterName": { - "description": "(Optional) Not supported by Cloud Run The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.", + "description": "Not supported by Cloud Run", "type": "string" }, "creationTimestamp": { - "description": "(Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata", + "description": "UTC timestamp representing the server time when this object was created. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata", "format": "google-datetime", "type": "string" }, "deletionGracePeriodSeconds": { - "description": "(Optional) Not supported by Cloud Run Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.", + "description": "Not supported by Cloud Run", "format": "int32", "type": "integer" }, "deletionTimestamp": { - "description": "(Optional) Not supported by Cloud Run DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata", + "description": "The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.", "format": "google-datetime", "type": "string" }, "finalizers": { - "description": "(Optional) Not supported by Cloud Run Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +patchStrategy=merge", + "description": "Not supported by Cloud Run", "items": { "type": "string" }, "type": "array" }, "generateName": { - "description": "(Optional) Not supported by Cloud Run GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2;", + "description": "Not supported by Cloud Run", "type": "string" }, "generation": { - "description": "(Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.", + "description": "A system-provided sequence number representing a specific generation of the desired state.", "format": "int32", "type": "integer" }, @@ -3579,65 +3580,65 @@ "additionalProperties": { "type": "string" }, - "description": "(Optional) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/user-guide/labels", + "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: https://kubernetes.io/docs/user-guide/labels", "type": "object" }, "name": { - "description": "Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/user-guide/identifiers#names If ObjectMeta is part of a namespaces.services.create request, name must contain fewer than 50 characters. +optional", + "description": "The immutable name of the resource. In Cloud Run, name is required when creating top-level resources (Service, Job), and must be unique within a Cloud Run project/region. More info: https://kubernetes.io/docs/user-guide/identifiers#names If ObjectMeta is part of a CreateServiceRequest, name must contain fewer than 50 characters. Otherwise,", "type": "string" }, "namespace": { - "description": "Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.", + "description": "Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.", "type": "string" }, "ownerReferences": { - "description": "(Optional) Not supported by Cloud Run List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected.", + "description": "Not supported by Cloud Run", "items": { "$ref": "OwnerReference" }, "type": "array" }, "resourceVersion": { - "description": "Optional. An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients or omitted. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency", + "description": "Optional. Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency", "type": "string" }, "selfLink": { - "description": "(Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4;", + "description": "URL representing this object.", "type": "string" }, "uid": { - "description": "(Optional) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/user-guide/identifiers#uids", + "description": "Unique, system-generated identifier for this resource. More info: https://kubernetes.io/docs/user-guide/identifiers#uids", "type": "string" } }, "type": "object" }, "OwnerReference": { - "description": "OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.", + "description": "This is not supported or used by Cloud Run.", "id": "OwnerReference", "properties": { "apiVersion": { - "description": "API version of the referent.", + "description": "This is not supported or used by Cloud Run.", "type": "string" }, "blockOwnerDeletion": { - "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional", + "description": "This is not supported or used by Cloud Run.", "type": "boolean" }, "controller": { - "description": "If true, this reference points to the managing controller. +optional", + "description": "This is not supported or used by Cloud Run.", "type": "boolean" }, "kind": { - "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "description": "This is not supported or used by Cloud Run.", "type": "string" }, "name": { - "description": "Name of the referent. More info: https://kubernetes.io/docs/user-guide/identifiers#names", + "description": "This is not supported or used by Cloud Run.", "type": "string" }, "uid": { - "description": "UID of the referent. More info: https://kubernetes.io/docs/user-guide/identifiers#uids", + "description": "This is not supported or used by Cloud Run.", "type": "string" } }, @@ -3675,47 +3676,47 @@ "type": "object" }, "Probe": { - "description": "Not supported by Cloud Run Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "id": "Probe", "properties": { "exec": { "$ref": "ExecAction", - "description": "(Optional) Not supported by Cloud Run One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message." + "description": "Not supported by Cloud Run." }, "failureThreshold": { - "description": "(Optional) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", "format": "int32", "type": "integer" }, "grpc": { "$ref": "GRPCAction", - "description": "(Optional) GRPCAction specifies an action involving a GRPC port. A field inlined from the Handler message." + "description": "GRPCAction specifies an action involving a GRPC port." }, "httpGet": { "$ref": "HTTPGetAction", - "description": "(Optional) HTTPGet specifies the http request to perform. A field inlined from the Handler message." + "description": "HTTPGet specifies the http request to perform." }, "initialDelaySeconds": { - "description": "(Optional) Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "description": "Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": "integer" }, "periodSeconds": { - "description": "(Optional) How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.", "format": "int32", "type": "integer" }, "successThreshold": { - "description": "(Optional) Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.", "format": "int32", "type": "integer" }, "tcpSocket": { "$ref": "TCPSocketAction", - "description": "(Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message." + "description": "TCPSocket specifies an action involving a TCP port." }, "timeoutSeconds": { - "description": "(Optional) Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": "integer" } @@ -3761,21 +3762,21 @@ "additionalProperties": { "type": "string" }, - "description": "(Optional) Only memory and CPU are supported. Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go", + "description": "Only memory and CPU are supported. Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go", "type": "object" }, "requests": { "additionalProperties": { "type": "string" }, - "description": "(Optional) Only memory and CPU are supported. Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go", + "description": "Only memory and CPU are supported. Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go", "type": "object" } }, "type": "object" }, "Revision": { - "description": "Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision", + "description": "Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision", "id": "Revision", "properties": { "apiVersion": { @@ -3806,23 +3807,23 @@ "id": "RevisionSpec", "properties": { "containerConcurrency": { - "description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. Cloud Run fully managed: supported, defaults to 80 Cloud Run for Anthos: supported, defaults to 0, which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler.", + "description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. Cloud Run: supported, defaults to 80", "format": "int32", "type": "integer" }, "containers": { - "description": "Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. The runtime contract is documented here: https://github.com/knative/serving/blob/main/docs/runtime-contract.md", + "description": "Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. The runtime contract is documented here: https://github.com/knative/specs/blob/main/specs/serving/runtime-contract.md", "items": { "$ref": "Container" }, "type": "array" }, "enableServiceLinks": { - "description": "Indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Cloud Run fully managed: Not supported. Cloud Run for Anthos: supported, defaults to true.", + "description": "Not supported by Cloud Run.", "type": "boolean" }, "imagePullSecrets": { - "description": "ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod Cloud Run fully managed: Not supported. Cloud Run for Anthos: supported.", + "description": "Not supported by Cloud Run.", "items": { "$ref": "LocalObjectReference" }, @@ -3833,7 +3834,7 @@ "type": "string" }, "timeoutSeconds": { - "description": "TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run fully managed: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour). Cloud Run for Anthos: defaults to 300 seconds (5 minutes). Maximum allowed value is configurable by the cluster operator.", + "description": "TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).", "format": "int32", "type": "integer" }, @@ -3893,7 +3894,7 @@ "type": "object" }, "Route": { - "description": "Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for \"latest ready\" revision changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#route Cloud Run currently supports referencing a single Configuration to automatically deploy the \"latest ready\" Revision from that Configuration.", + "description": "Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for \"latest ready\" revision changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#route Cloud Run currently supports referencing a single Configuration to automatically deploy the \"latest ready\" Revision from that Configuration.", "id": "Route", "properties": { "apiVersion": { @@ -3954,7 +3955,7 @@ "type": "integer" }, "traffic": { - "description": "Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed.", + "description": "Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that was last observed.", "items": { "$ref": "TrafficTarget" }, @@ -3974,7 +3975,7 @@ "type": "object" }, "SecretEnvSource": { - "description": "Not supported by Cloud Run SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.", + "description": "Not supported by Cloud Run. SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.", "id": "SecretEnvSource", "properties": { "localObjectReference": { @@ -3986,7 +3987,7 @@ "type": "string" }, "optional": { - "description": "(Optional) Specify whether the Secret must be defined", + "description": "Specify whether the Secret must be defined", "type": "boolean" } }, @@ -3997,7 +3998,7 @@ "id": "SecretKeySelector", "properties": { "key": { - "description": "A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. The key of the secret to select from. Must be a valid secret key.", + "description": "Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version or an integer for a specific version. The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "localObjectReference": { @@ -4009,14 +4010,14 @@ "type": "string" }, "optional": { - "description": "(Optional) Specify whether the Secret or its key must be defined", + "description": "Specify whether the Secret or its key must be defined.", "type": "boolean" } }, "type": "object" }, "SecretVolumeSource": { - "description": "The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.", + "description": "A volume representing a secret stored in Google Secret Manager. The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.", "id": "SecretVolumeSource", "properties": { "defaultMode": { @@ -4025,14 +4026,14 @@ "type": "integer" }, "items": { - "description": "(Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional.", + "description": "A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify both a key and a path.", "items": { "$ref": "KeyToPath" }, "type": "array" }, "optional": { - "description": "(Optional) Specify whether the Secret or its keys must be defined.", + "description": "Not supported by Cloud Run.", "type": "boolean" }, "secretName": { @@ -4043,11 +4044,11 @@ "type": "object" }, "SecurityContext": { - "description": "Not supported by Cloud Run SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", + "description": "Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", "id": "SecurityContext", "properties": { "runAsUser": { - "description": "(Optional) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", + "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", "format": "int32", "type": "integer" } @@ -4059,24 +4060,24 @@ "id": "Service", "properties": { "apiVersion": { - "description": "The API version for this call such as \"serving.knative.dev/v1\".", + "description": "The API version for this call. It must be \"serving.knative.dev/v1\".", "type": "string" }, "kind": { - "description": "The kind of resource, in this case \"Service\".", + "description": "The kind of resource. It must be \"Service\".", "type": "string" }, "metadata": { "$ref": "ObjectMeta", - "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. Cloud Run (fully managed) uses the following annotation keys to configure features on a Service: * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." + "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." }, "spec": { "$ref": "ServiceSpec", - "description": "Spec holds the desired state of the Service (from the client)." + "description": "Holds the desired state of the Service (from the client)." }, "status": { "$ref": "ServiceStatus", - "description": "Status communicates the observed state of the Service (from the controller)." + "description": "Communicates the system-controlled state of the Service." } }, "type": "object" @@ -4087,10 +4088,10 @@ "properties": { "template": { "$ref": "RevisionTemplate", - "description": "Template holds the latest specification for the Revision to be stamped out." + "description": "Holds the latest specification for the Revision to be stamped out." }, "traffic": { - "description": "Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations.", + "description": "Specifies how to distribute traffic over a collection of Knative Revisions and Configurations to the Service's main URL.", "items": { "$ref": "TrafficTarget" }, @@ -4105,37 +4106,37 @@ "properties": { "address": { "$ref": "Addressable", - "description": "From RouteStatus. Similar to url, information on where the service is available on HTTP." + "description": "Similar to url, information on where the service is available on HTTP." }, "conditions": { - "description": "Conditions communicates information about ongoing/complete reconciliation processes that bring the \"spec\" inline with the observed state of the world. Service-specific conditions include: * \"ConfigurationsReady\": true when the underlying Configuration is ready. * \"RoutesReady\": true when the underlying Route is ready. * \"Ready\": true when both the underlying Route and Configuration are ready.", + "description": "Communicates information about ongoing/complete reconciliation processes that bring the `spec` inline with the observed state of the world. Service-specific conditions include: * `ConfigurationsReady`: `True` when the underlying Configuration is ready. * `RoutesReady`: `True` when the underlying Route is ready. * `Ready`: `True` when all underlying resources are ready.", "items": { "$ref": "GoogleCloudRunV1Condition" }, "type": "array" }, "latestCreatedRevisionName": { - "description": "From ConfigurationStatus. LatestCreatedRevisionName is the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName.", + "description": "Name of the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName.", "type": "string" }, "latestReadyRevisionName": { - "description": "From ConfigurationStatus. LatestReadyRevisionName holds the name of the latest Revision stamped out from this Service's Configuration that has had its \"Ready\" condition become \"True\".", + "description": "Name of the latest Revision from this Service's Configuration that has had its `Ready` condition become `True`.", "type": "string" }, "observedGeneration": { - "description": "ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.", + "description": "Returns the generation last fully processed by the system. This will only match metadata.generation when reconciliation is complete. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.", "format": "int32", "type": "integer" }, "traffic": { - "description": "From RouteStatus. Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed.", + "description": "Holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed.", "items": { "$ref": "TrafficTarget" }, "type": "array" }, "url": { - "description": "From RouteStatus. URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app", + "description": "URL that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app", "type": "string" } }, @@ -4158,32 +4159,32 @@ "type": "object" }, "Status": { - "description": "Status is a return value for calls that don't return other objects", + "description": "Status is a return value for calls that don't return other objects.", "id": "Status", "properties": { "code": { - "description": "Suggested HTTP return code for this status, 0 if not set. +optional", + "description": "Suggested HTTP return code for this status, 0 if not set.", "format": "int32", "type": "integer" }, "details": { "$ref": "StatusDetails", - "description": "Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. +optional" + "description": "Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type." }, "message": { - "description": "A human-readable description of the status of this operation. +optional", + "description": "A human-readable description of the status of this operation.", "type": "string" }, "metadata": { "$ref": "ListMeta", - "description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional" + "description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" }, "reason": { - "description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. +optional", + "description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.", "type": "string" }, "status": { - "description": "Status of the operation. One of: \"Success\" or \"Failure\". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional", + "description": "Status of the operation. One of: \"Success\" or \"Failure\". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "type": "string" } }, @@ -4194,15 +4195,15 @@ "id": "StatusCause", "properties": { "field": { - "description": "The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: \"name\" - the field \"name\" on the current resource \"items[0].name\" - the field \"name\" on the first array entry in \"items\" +optional", + "description": "The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Examples: \"name\" - the field \"name\" on the current resource \"items[0].name\" - the field \"name\" on the first array entry in \"items\"", "type": "string" }, "message": { - "description": "A human-readable description of the cause of the error. This field may be presented as-is to a reader. +optional", + "description": "A human-readable description of the cause of the error. This field may be presented as-is to a reader.", "type": "string" }, "reason": { - "description": "A machine-readable description of the cause of the error. If this value is empty there is no information available. +optional", + "description": "A machine-readable description of the cause of the error. If this value is empty there is no information available.", "type": "string" } }, @@ -4213,31 +4214,31 @@ "id": "StatusDetails", "properties": { "causes": { - "description": "The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. +optional", + "description": "The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.", "items": { "$ref": "StatusCause" }, "type": "array" }, "group": { - "description": "The group attribute of the resource associated with the status StatusReason. +optional", + "description": "The group attribute of the resource associated with the status StatusReason.", "type": "string" }, "kind": { - "description": "The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional", + "description": "The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "name": { - "description": "The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). +optional", + "description": "The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).", "type": "string" }, "retryAfterSeconds": { - "description": "If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. +optional", + "description": "If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.", "format": "int32", "type": "integer" }, "uid": { - "description": "UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/user-guide/identifiers#uids +optional", + "description": "UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/user-guide/identifiers#uids", "type": "string" } }, @@ -4248,11 +4249,11 @@ "id": "TCPSocketAction", "properties": { "host": { - "description": "(Optional) Optional: Host name to connect to, defaults to the pod IP.", + "description": "Not supported by Cloud Run.", "type": "string" }, "port": { - "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This field is currently limited to integer types only because of proto's inability to properly support the IntOrString golang type.", + "description": "Port number to access on the container. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" } @@ -4264,24 +4265,24 @@ "id": "Task", "properties": { "apiVersion": { - "description": "Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional", + "description": "Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { - "description": "Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional", + "description": "Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "$ref": "ObjectMeta", - "description": "Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional" + "description": "Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" }, "spec": { "$ref": "TaskSpec", - "description": "Optional. Specification of the desired behavior of an execution. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional" + "description": "Optional. Specification of the desired behavior of a task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" }, "status": { "$ref": "TaskStatus", - "description": "Output only. Current status of an execution. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional", + "description": "Output only. Current status of a task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "readOnly": true } }, @@ -4320,16 +4321,16 @@ "type": "integer" }, "serviceAccountName": { - "description": "Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. +optional", + "description": "Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.", "type": "string" }, "timeoutSeconds": { - "description": "Optional. Optional duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. +optional", + "description": "Optional. Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.", "format": "int64", "type": "string" }, "volumes": { - "description": "Optional. List of volumes that can be mounted by containers belonging to the task. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional", + "description": "Optional. List of volumes that can be mounted by containers belonging to the task. More info: https://kubernetes.io/docs/concepts/storage/volumes", "items": { "$ref": "Volume" }, @@ -4339,16 +4340,16 @@ "type": "object" }, "TaskStatus": { - "description": "TaskStatus represents the status of a task of a job execution.", + "description": "TaskStatus represents the status of a task.", "id": "TaskStatus", "properties": { "completionTime": { - "description": "Optional. Represents time when the task was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional", + "description": "Optional. Represents time when the task was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "format": "google-datetime", "type": "string" }, "conditions": { - "description": "Optional. The latest available observations of a task's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional", + "description": "Optional. The latest available observations of a task's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/job/", "items": { "$ref": "GoogleCloudRunV1Condition" }, @@ -4361,24 +4362,24 @@ }, "lastAttemptResult": { "$ref": "TaskAttemptResult", - "description": "Optional. Result of the last attempt of this task. +optional" + "description": "Optional. Result of the last attempt of this task." }, "logUri": { "description": "Optional. URI where logs for this task can be found in Cloud Console.", "type": "string" }, "observedGeneration": { - "description": "Optional. The 'generation' of the execution that was last processed by the controller.", + "description": "Optional. The 'generation' of the task that was last processed by the controller.", "format": "int32", "type": "integer" }, "retried": { - "description": "Optional. The number of times this task was retried. Instances are retried when they fail up to the maxRetries limit. +optional", + "description": "Optional. The number of times this task was retried. Instances are retried when they fail up to the maxRetries limit.", "format": "int32", "type": "integer" }, "startTime": { - "description": "Optional. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional", + "description": "Optional. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.", "format": "google-datetime", "type": "string" } @@ -4391,7 +4392,7 @@ "properties": { "spec": { "$ref": "TaskSpec", - "description": "Optional. Specification of the desired behavior of the task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional" + "description": "Optional. Specification of the desired behavior of the task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" } }, "type": "object" @@ -4429,7 +4430,7 @@ "id": "TrafficTarget", "properties": { "configurationName": { - "description": "ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the \"status.latestReadyRevisionName\" of the referenced configuration changes, we will automatically migrate traffic from the prior \"latest ready\" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName.", + "description": "ConfigurationName of a configuration to whose latest revision which will be sent this portion of traffic. When the \"status.latestReadyRevisionName\" of the referenced configuration changes, traffic will automatically migrate from the prior \"latest ready\" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName.", "type": "string" }, "latestRevision": { @@ -4461,14 +4462,16 @@ "id": "Volume", "properties": { "configMap": { - "$ref": "ConfigMapVolumeSource" + "$ref": "ConfigMapVolumeSource", + "description": "Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths." }, "name": { "description": "Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved.", "type": "string" }, "secret": { - "$ref": "SecretVolumeSource" + "$ref": "SecretVolumeSource", + "description": "The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secretName." } }, "type": "object" @@ -4478,19 +4481,19 @@ "id": "VolumeMount", "properties": { "mountPath": { - "description": "Path within the container at which the volume should be mounted. Must not contain ':'.", + "description": "Required. Path within the container at which the volume should be mounted. Must not contain ':'.", "type": "string" }, "name": { - "description": "The name of the volume. There must be a corresponding Volume with the same name.", + "description": "Required. The name of the volume. There must be a corresponding Volume with the same name.", "type": "string" }, "readOnly": { - "description": "(Optional) Only true is accepted. Defaults to true.", + "description": "Only true is accepted for Secret Volumes. Defaults to true for Secrets Volumes.", "type": "boolean" }, "subPath": { - "description": "(Optional) Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).", + "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).", "type": "string" } }, diff --git a/run/v1/run-gen.go b/run/v1/run-gen.go index 8e71e2d84d9..e3d9a6cb01b 100644 --- a/run/v1/run-gen.go +++ b/run/v1/run-gen.go @@ -616,7 +616,7 @@ func (s *Binding) MarshalJSON() ([]byte, error) { type CancelExecutionRequest struct { } -// ConfigMapEnvSource: Not supported by Cloud Run ConfigMapEnvSource +// ConfigMapEnvSource: Not supported by Cloud Run. ConfigMapEnvSource // selects a ConfigMap to populate the environment variables with. The // contents of the target ConfigMap's Data field will represent the // key-value pairs as environment variables. @@ -629,7 +629,7 @@ type ConfigMapEnvSource struct { // Name: The ConfigMap to select from. Name string `json:"name,omitempty"` - // Optional: (Optional) Specify whether the ConfigMap must be defined + // Optional: Specify whether the ConfigMap must be defined. Optional bool `json:"optional,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -657,10 +657,10 @@ func (s *ConfigMapEnvSource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ConfigMapKeySelector: Not supported by Cloud Run Selects a key from a -// ConfigMap. +// ConfigMapKeySelector: Not supported by Cloud Run. Selects a key from +// a ConfigMap. type ConfigMapKeySelector struct { - // Key: The key to select. + // Key: Required. The key to select. Key string `json:"key,omitempty"` // LocalObjectReference: This field should not be used directly as it is @@ -668,11 +668,10 @@ type ConfigMapKeySelector struct { // instead. LocalObjectReference *LocalObjectReference `json:"localObjectReference,omitempty"` - // Name: The ConfigMap to select from. + // Name: Required. The ConfigMap to select from. Name string `json:"name,omitempty"` - // Optional: (Optional) Specify whether the ConfigMap or its key must be - // defined + // Optional: Specify whether the ConfigMap or its key must be defined Optional bool `json:"optional,omitempty"` // ForceSendFields is a list of field names (e.g. "Key") to @@ -698,7 +697,7 @@ func (s *ConfigMapKeySelector) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ConfigMapVolumeSource: Not supported by Cloud Run Adapts a ConfigMap +// ConfigMapVolumeSource: Not supported by Cloud Run. Adapts a ConfigMap // into a volume. The contents of the target ConfigMap's Data field will // be presented in a volume as files using the keys in the Data field as // the file names, unless the items element is populated with specific @@ -764,7 +763,7 @@ func (s *ConfigMapVolumeSource) MarshalJSON() ([]byte, error) { // the Configuration's spec. The "latest created" revision's name is // available under status, as is the "latest ready" revision's name. See // also: -// https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration +// https://github.com/knative/specs/blob/main/specs/serving/overview.md#configuration type Configuration struct { // ApiVersion: The API version for this call such as // "serving.knative.dev/v1". @@ -845,14 +844,15 @@ func (s *ConfigurationSpec) MarshalJSON() ([]byte, error) { // ConfigurationStatus: ConfigurationStatus communicates the observed // state of the Configuration (from the controller). type ConfigurationStatus struct { - // Conditions: Conditions communicates information about - // ongoing/complete reconciliation processes that bring the "spec" - // inline with the observed state of the world. + // Conditions: Conditions communicate information about ongoing/complete + // reconciliation processes that bring the "spec" inline with the + // observed state of the world. Conditions []*GoogleCloudRunV1Condition `json:"conditions,omitempty"` // LatestCreatedRevisionName: LatestCreatedRevisionName is the last // revision that was created from this Configuration. It might not be - // ready yet, for that use LatestReadyRevisionName. + // ready yet, so for the latest ready revision, use + // LatestReadyRevisionName. LatestCreatedRevisionName string `json:"latestCreatedRevisionName,omitempty"` // LatestReadyRevisionName: LatestReadyRevisionName holds the name of @@ -897,111 +897,105 @@ func (s *ConfigurationStatus) MarshalJSON() ([]byte, error) { // arguments to supply to it. Note that additional arguments may be // supplied by the system to the container at runtime. type Container struct { - // Args: (Optional) Arguments to the entrypoint. The docker image's CMD - // is used if this is not provided. Variable references $(VAR_NAME) are - // expanded using the container's environment. If a variable cannot be - // resolved, the reference in the input string will be unchanged. The - // $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). - // Escaped references will never be expanded, regardless of whether the - // variable exists or not. More info: + // Args: Arguments to the entrypoint. The docker image's CMD is used if + // this is not provided. Variable references $(VAR_NAME) are expanded + // using the container's environment. If a variable cannot be resolved, + // the reference in the input string will be unchanged. The $(VAR_NAME) + // syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + // references will never be expanded, regardless of whether the variable + // exists or not. More info: // https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell Args []string `json:"args,omitempty"` + // Command: Entrypoint array. Not executed within a shell. The docker + // image's ENTRYPOINT is used if this is not provided. Variable + // references $(VAR_NAME) are expanded using the container's + // environment. If a variable cannot be resolved, the reference in the + // input string will be unchanged. The $(VAR_NAME) syntax can be escaped + // with a double $$, ie: $$(VAR_NAME). Escaped references will never be + // expanded, regardless of whether the variable exists or not. More + // info: + // https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell Command []string `json:"command,omitempty"` - // Env: (Optional) List of environment variables to set in the - // container. + // Env: List of environment variables to set in the container. Env []*EnvVar `json:"env,omitempty"` - // EnvFrom: (Optional) List of sources to populate environment variables - // in the container. The keys defined within a source must be a - // C_IDENTIFIER. All invalid keys will be reported as an event when the - // container is starting. When a key exists in multiple sources, the - // value associated with the last source will take precedence. Values - // defined by an Env with a duplicate key will take precedence. Cannot - // be updated. + // EnvFrom: Not supported by Cloud Run. EnvFrom []*EnvFromSource `json:"envFrom,omitempty"` - // Image: Only supports containers from Google Container Registry or - // Artifact Registry URL of the Container image. More info: + // Image: Required. URL of the Container image in Google Container + // Registry or Google Artifact Registry. More info: // https://kubernetes.io/docs/concepts/containers/images Image string `json:"image,omitempty"` - // ImagePullPolicy: (Optional) Image pull policy. One of Always, Never, + // ImagePullPolicy: Image pull policy. One of Always, Never, // IfNotPresent. Defaults to Always if :latest tag is specified, or // IfNotPresent otherwise. More info: // https://kubernetes.io/docs/concepts/containers/images#updating-images ImagePullPolicy string `json:"imagePullPolicy,omitempty"` - // LivenessProbe: (Optional) Periodic probe of container liveness. - // Container will be restarted if the probe fails. More info: + // LivenessProbe: Periodic probe of container liveness. Container will + // be restarted if the probe fails. More info: // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes LivenessProbe *Probe `json:"livenessProbe,omitempty"` - // Name: (Optional) Name of the container specified as a DNS_LABEL. - // Currently unused in Cloud Run. More info: + // Name: Name of the container specified as a DNS_LABEL. Currently + // unused in Cloud Run. More info: // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names Name string `json:"name,omitempty"` - // Ports: (Optional) List of ports to expose from the container. Only a - // single port can be specified. The specified ports must be listening - // on all interfaces (0.0.0.0) within the container to be accessible. If + // Ports: List of ports to expose from the container. Only a single port + // can be specified. The specified ports must be listening on all + // interfaces (0.0.0.0) within the container to be accessible. If // omitted, a port number will be chosen and passed to the container // through the PORT environment variable for the container to listen on. Ports []*ContainerPort `json:"ports,omitempty"` - // ReadinessProbe: (Optional) Periodic probe of container service - // readiness. Container will be removed from service endpoints if the - // probe fails. More info: - // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + // ReadinessProbe: Not supported by Cloud Run. ReadinessProbe *Probe `json:"readinessProbe,omitempty"` - // Resources: (Optional) Compute Resources required by this container. - // More info: + // Resources: Compute Resources required by this container. More info: // https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Resources *ResourceRequirements `json:"resources,omitempty"` - // SecurityContext: (Optional) Security options the pod should run with. - // More info: - // https://kubernetes.io/docs/concepts/policy/security-context/ More - // info: - // https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + // SecurityContext: Not supported by Cloud Run. SecurityContext *SecurityContext `json:"securityContext,omitempty"` - // StartupProbe: (Optional) Startup probe of application within the - // container. All other probes are disabled if a startup probe is - // provided, until it succeeds. Container will not be added to service - // endpoints if the probe fails. More info: + // StartupProbe: Startup probe of application within the container. All + // other probes are disabled if a startup probe is provided, until it + // succeeds. Container will not receive traffic if the probe fails. If + // not provided, a default startup probe with TCP socket action is used. + // More info: // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes StartupProbe *Probe `json:"startupProbe,omitempty"` - // TerminationMessagePath: (Optional) Path at which the file to which - // the container's termination message will be written is mounted into - // the container's filesystem. Message written is intended to be brief - // final status, such as an assertion failure message. Will be truncated - // by the node if greater than 4096 bytes. The total message length - // across all containers will be limited to 12kb. Defaults to + // TerminationMessagePath: Path at which the file to which the + // container's termination message will be written is mounted into the + // container's filesystem. Message written is intended to be brief final + // status, such as an assertion failure message. Will be truncated by + // the node if greater than 4096 bytes. The total message length across + // all containers will be limited to 12kb. Defaults to // /dev/termination-log. TerminationMessagePath string `json:"terminationMessagePath,omitempty"` - // TerminationMessagePolicy: (Optional) Indicate how the termination - // message should be populated. File will use the contents of - // terminationMessagePath to populate the container status message on - // both success and failure. FallbackToLogsOnError will use the last - // chunk of container log output if the termination message file is - // empty and the container exited with an error. The log output is - // limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to - // File. Cannot be updated. + // TerminationMessagePolicy: Indicate how the termination message should + // be populated. File will use the contents of terminationMessagePath to + // populate the container status message on both success and failure. + // FallbackToLogsOnError will use the last chunk of container log output + // if the termination message file is empty and the container exited + // with an error. The log output is limited to 2048 bytes or 80 lines, + // whichever is smaller. Defaults to File. Cannot be updated. TerminationMessagePolicy string `json:"terminationMessagePolicy,omitempty"` - // VolumeMounts: (Optional) Volume to mount into the container's - // filesystem. Only supports SecretVolumeSources. Pod volumes to mount - // into the container's filesystem. + // VolumeMounts: Volume to mount into the container's filesystem. Only + // supports SecretVolumeSources. Pod volumes to mount into the + // container's filesystem. VolumeMounts []*VolumeMount `json:"volumeMounts,omitempty"` - // WorkingDir: (Optional) Container's working directory. If not - // specified, the container runtime's default will be used, which might - // be configured in the container image. + // WorkingDir: Container's working directory. If not specified, the + // container runtime's default will be used, which might be configured + // in the container image. WorkingDir string `json:"workingDir,omitempty"` // ForceSendFields is a list of field names (e.g. "Args") to @@ -1030,16 +1024,15 @@ func (s *Container) MarshalJSON() ([]byte, error) { // ContainerPort: ContainerPort represents a network port in a single // container. type ContainerPort struct { - // ContainerPort: (Optional) Port number the container listens on. This - // must be a valid port number, 0 < x < 65536. + // ContainerPort: Port number the container listens on. This must be a + // valid port number, 0 < x < 65536. ContainerPort int64 `json:"containerPort,omitempty"` - // Name: (Optional) If specified, used to specify which protocol to use. - // Allowed values are "http1" and "h2c". + // Name: If specified, used to specify which protocol to use. Allowed + // values are "http1" and "h2c". Name string `json:"name,omitempty"` - // Protocol: (Optional) Protocol for port. Must be "TCP". Defaults to - // "TCP". + // Protocol: Protocol for port. Must be "TCP". Defaults to "TCP". Protocol string `json:"protocol,omitempty"` // ForceSendFields is a list of field names (e.g. "ContainerPort") to @@ -1119,7 +1112,7 @@ type DomainMappingSpec struct { // "CERTIFICATE_MODE_UNSPECIFIED" // "NONE" - Do not provision an HTTPS certificate. // "AUTOMATIC" - Automatically provisions an HTTPS certificate via - // GoogleCA or LetsEncrypt. + // GoogleCA. CertificateMode string `json:"certificateMode,omitempty"` // ForceOverride: If set, the mapping will override any mapping set @@ -1179,9 +1172,7 @@ type DomainMappingStatus struct { // mapping. ResourceRecords []*ResourceRecord `json:"resourceRecords,omitempty"` - // Url: Optional. Cloud Run fully managed: not supported Cloud Run on - // GKE: supported Holds the URL that will serve the traffic of the - // DomainMapping. + // Url: Optional. Not supported by Cloud Run. Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "Conditions") to @@ -1207,17 +1198,17 @@ func (s *DomainMappingStatus) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// EnvFromSource: Not supported by Cloud Run EnvFromSource represents +// EnvFromSource: Not supported by Cloud Run. EnvFromSource represents // the source of a set of ConfigMaps type EnvFromSource struct { - // ConfigMapRef: (Optional) The ConfigMap to select from + // ConfigMapRef: The ConfigMap to select from ConfigMapRef *ConfigMapEnvSource `json:"configMapRef,omitempty"` - // Prefix: (Optional) An optional identifier to prepend to each key in - // the ConfigMap. Must be a C_IDENTIFIER. + // Prefix: An optional identifier to prepend to each key in the + // ConfigMap. Must be a C_IDENTIFIER. Prefix string `json:"prefix,omitempty"` - // SecretRef: (Optional) The Secret to select from + // SecretRef: The Secret to select from SecretRef *SecretEnvSource `json:"secretRef,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfigMapRef") to @@ -1246,21 +1237,21 @@ func (s *EnvFromSource) MarshalJSON() ([]byte, error) { // EnvVar: EnvVar represents an environment variable present in a // Container. type EnvVar struct { - // Name: Name of the environment variable. Must be a C_IDENTIFIER. + // Name: Required. Name of the environment variable. Must be a + // C_IDENTIFIER. Name string `json:"name,omitempty"` - // Value: (Optional) Variable references $(VAR_NAME) are expanded using - // the previous defined environment variables in the container and any - // route environment variables. If a variable cannot be resolved, the + // Value: Variable references $(VAR_NAME) are expanded using the + // previous defined environment variables in the container and any route + // environment variables. If a variable cannot be resolved, the // reference in the input string will be unchanged. The $(VAR_NAME) // syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped // references will never be expanded, regardless of whether the variable // exists or not. Defaults to "". Value string `json:"value,omitempty"` - // ValueFrom: (Optional) Source for the environment variable's value. - // Only supports secret_key_ref. Source for the environment variable's - // value. Cannot be used if value is not empty. + // ValueFrom: Source for the environment variable's value. Only supports + // secret_key_ref. Cannot be used if value is not empty. ValueFrom *EnvVarSource `json:"valueFrom,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to @@ -1289,12 +1280,11 @@ func (s *EnvVar) MarshalJSON() ([]byte, error) { // EnvVarSource: EnvVarSource represents a source for the value of an // EnvVar. type EnvVarSource struct { - // ConfigMapKeyRef: (Optional) Not supported by Cloud Run Selects a key - // of a ConfigMap. + // ConfigMapKeyRef: Not supported by Cloud Run. Selects a key of a + // ConfigMap. ConfigMapKeyRef *ConfigMapKeySelector `json:"configMapKeyRef,omitempty"` - // SecretKeyRef: (Optional) Selects a key (version) of a secret in - // Secret Manager. + // SecretKeyRef: Selects a key (version) of a secret in Secret Manager. SecretKeyRef *SecretKeySelector `json:"secretKeyRef,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfigMapKeyRef") to @@ -1321,11 +1311,11 @@ func (s *EnvVarSource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExecAction: Not supported by Cloud Run ExecAction describes a "run in -// container" action. +// ExecAction: Not supported by Cloud Run. ExecAction describes a "run +// in container" action. type ExecAction struct { - // Command: (Optional) Command is the command line to execute inside the - // container, the working directory for the command is root ('/') in the + // Command: Command is the command line to execute inside the container, + // the working directory for the command is root ('/') in the // container's filesystem. The command is simply exec'd, it is not run // inside a shell, so traditional shell instructions ('|', etc) won't // work. To use a shell, you need to explicitly call out to that shell. @@ -1357,7 +1347,7 @@ func (s *ExecAction) MarshalJSON() ([]byte, error) { } // Execution: Execution represents the configuration of a single -// execution. A execution an immutable resource that references a +// execution. An execution is an immutable resource that references a // container image which is run to completion. type Execution struct { // ApiVersion: Optional. APIVersion defines the versioned schema of this @@ -1365,7 +1355,6 @@ type Execution struct { // schemas to the latest internal value, and may reject unrecognized // values. More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - // +optional ApiVersion string `json:"apiVersion,omitempty"` // Kind: Optional. Kind is a string value representing the REST resource @@ -1373,23 +1362,19 @@ type Execution struct { // client submits requests to. Cannot be updated. In CamelCase. More // info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - // +optional Kind string `json:"kind,omitempty"` // Metadata: Optional. Standard object's metadata. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *ObjectMeta `json:"metadata,omitempty"` // Spec: Optional. Specification of the desired behavior of an // execution. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec *ExecutionSpec `json:"spec,omitempty"` // Status: Output only. Current status of an execution. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Status *ExecutionStatus `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1463,16 +1448,14 @@ type ExecutionSpec struct { // the job is run, if this field is 0 or unset, the maximum possible // value will be used for that execution. The actual number of tasks // running in steady state will be less than this number when there are - // fewer tasks waiting to be completed remaining, i.e. when the work - // left to do is less than max parallelism. +optional + // fewer tasks waiting to be completed, i.e. when the work left to do is + // less than max parallelism. Parallelism int64 `json:"parallelism,omitempty"` // TaskCount: Optional. Specifies the desired number of tasks the // execution should run. Setting to 1 means that parallelism is limited // to 1 and the success of that task signals the success of the - // execution. More info: - // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ - // +optional + // execution. TaskCount int64 `json:"taskCount,omitempty"` // Template: Optional. Describes the task(s) that will be created when @@ -1502,27 +1485,25 @@ func (s *ExecutionSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExecutionStatus: ExecutionStatus represents the current state of a +// ExecutionStatus: ExecutionStatus represents the current state of an // Execution. type ExecutionStatus struct { // CancelledCount: Optional. The number of tasks which reached phase - // Cancelled. +optional + // Cancelled. CancelledCount int64 `json:"cancelledCount,omitempty"` - // CompletionTime: Optional. Represents time when the execution was + // CompletionTime: Optional. Represents the time that the execution was // completed. It is not guaranteed to be set in happens-before order // across separate operations. It is represented in RFC3339 form and is // in UTC. +optional CompletionTime string `json:"completionTime,omitempty"` // Conditions: Optional. The latest available observations of an - // execution's current state. More info: - // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ - // +optional + // execution's current state. Conditions []*GoogleCloudRunV1Condition `json:"conditions,omitempty"` // FailedCount: Optional. The number of tasks which reached phase - // Failed. +optional + // Failed. FailedCount int64 `json:"failedCount,omitempty"` // LogUri: Optional. URI where logs for this execution can be found in @@ -1534,21 +1515,19 @@ type ExecutionStatus struct { ObservedGeneration int64 `json:"observedGeneration,omitempty"` // RetriedCount: Optional. The number of tasks which have retried at - // least once. +optional + // least once. RetriedCount int64 `json:"retriedCount,omitempty"` // RunningCount: Optional. The number of actively running tasks. - // +optional RunningCount int64 `json:"runningCount,omitempty"` - // StartTime: Optional. Represents time when the execution started to - // run. It is not guaranteed to be set in happens-before order across + // StartTime: Optional. Represents the time that the execution started + // to run. It is not guaranteed to be set in happens-before order across // separate operations. It is represented in RFC3339 form and is in UTC. - // +optional StartTime string `json:"startTime,omitempty"` // SucceededCount: Optional. The number of tasks which reached phase - // Succeeded. +optional + // Succeeded. SucceededCount int64 `json:"succeededCount,omitempty"` // ForceSendFields is a list of field names (e.g. "CancelledCount") to @@ -1714,8 +1693,13 @@ func (s *GRPCAction) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleCloudRunV1Condition: Condition defines a generic condition for -// a Resource. +// GoogleCloudRunV1Condition: Conditions show the status of +// reconciliation progress on a given resource. Most resource use a +// top-level condition type "Ready" or "Completed" to show overall +// status with other conditions to checkpoint each stage of +// reconciliation. Note that if metadata.Generation does not equal +// status.ObservedGeneration, the conditions shown may not be relevant +// for the current spec. type GoogleCloudRunV1Condition struct { // LastTransitionTime: Optional. Last time the condition transitioned // from one status to another. @@ -1726,11 +1710,14 @@ type GoogleCloudRunV1Condition struct { Message string `json:"message,omitempty"` // Reason: Optional. One-word CamelCase reason for the condition's last - // transition. + // transition. These are intended to be stable, unique values which the + // client may use to trigger error handling logic, whereas messages + // which may be changed later by the server. Reason string `json:"reason,omitempty"` - // Severity: Optional. How to interpret failures of this condition, one - // of Error, Warning, Info + // Severity: Optional. How to interpret this condition. One of Error, + // Warning, or Info. Conditions of severity Info do not contribute to + // resource readiness. Severity string `json:"severity,omitempty"` // Status: Status of the condition, one of True, False, Unknown. @@ -1739,8 +1726,8 @@ type GoogleCloudRunV1Condition struct { // Type: type is used to communicate the status of the reconciliation // process. See also: // https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting - // Types common to all resources include: * "Ready": True when the - // Resource is ready. + // Types common to all resources include: * "Ready" or "Completed": True + // when the Resource is ready. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "LastTransitionTime") @@ -1814,19 +1801,17 @@ func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error) { // HTTPGetAction: HTTPGetAction describes an action based on HTTP Get // requests. type HTTPGetAction struct { - // Host: (Optional) Host name to connect to, defaults to the pod IP. You - // probably want to set "Host" in httpHeaders instead. + // Host: Not supported by Cloud Run. Host string `json:"host,omitempty"` - // HttpHeaders: (Optional) Custom headers to set in the request. HTTP - // allows repeated headers. + // HttpHeaders: Custom headers to set in the request. HTTP allows + // repeated headers. HttpHeaders []*HTTPHeader `json:"httpHeaders,omitempty"` - // Path: (Optional) Path to access on the HTTP server. + // Path: Path to access on the HTTP server. Path string `json:"path,omitempty"` - // Scheme: (Optional) Scheme to use for connecting to the host. Defaults - // to HTTP. + // Scheme: Not supported by Cloud Run. Scheme string `json:"scheme,omitempty"` // ForceSendFields is a list of field names (e.g. "Host") to @@ -1884,16 +1869,14 @@ func (s *HTTPHeader) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Job: Job represents the configuration of a single job. A job an -// immutable resource that references a container image which is run to -// completion. +// Job: Job represents the configuration of a single job, which +// references a container image which is run to completion. type Job struct { // ApiVersion: Optional. APIVersion defines the versioned schema of this // representation of an object. Servers should convert recognized // schemas to the latest internal value, and may reject unrecognized // values. More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - // +optional ApiVersion string `json:"apiVersion,omitempty"` // Kind: Optional. Kind is a string value representing the REST resource @@ -1901,23 +1884,19 @@ type Job struct { // client submits requests to. Cannot be updated. In CamelCase. More // info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - // +optional Kind string `json:"kind,omitempty"` // Metadata: Optional. Standard object's metadata. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *ObjectMeta `json:"metadata,omitempty"` // Spec: Optional. Specification of the desired behavior of a job. More // info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec *JobSpec `json:"spec,omitempty"` // Status: Output only. Current status of a job. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Status *JobStatus `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1980,7 +1959,7 @@ func (s *JobSpec) MarshalJSON() ([]byte, error) { type JobStatus struct { // Conditions: The latest available observations of a job's current // state. More info: - // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + // https://kubernetes.io/docs/concepts/workloads/controllers/job/ Conditions []*GoogleCloudRunV1Condition `json:"conditions,omitempty"` // ExecutionCount: Number of executions created for this job. @@ -2322,31 +2301,24 @@ func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ListMeta: ListMeta describes metadata that synthetic resources must -// have, including lists and various status objects. A resource may have -// only one of {ObjectMeta, ListMeta}. +// ListMeta: Metadata for synthetic resources like List. In Cloud Run, +// all List Resources Responses will have a ListMeta instead of +// ObjectMeta. type ListMeta struct { - // Continue: continue may be set if the user set a limit on the number - // of items returned, and indicates that the server has more data - // available. The value is opaque and may be used to issue another - // request to the endpoint that served this list to retrieve the next - // set of available objects. Continuing a list may not be possible if - // the server configuration has changed or more than a few minutes have - // passed. The resourceVersion field returned when using this continue - // value will be identical to the value in the first response. + // Continue: Continuation token is a value emitted when the count of + // items is larger than the user/system limit. To retrieve the next page + // of items, pass the value of `continue` as the next request's + // `page_token`. Continue string `json:"continue,omitempty"` - // ResourceVersion: String that identifies the server's internal version - // of this object that can be used by clients to determine when objects - // have changed. Value must be treated as opaque by clients and passed - // unmodified back to the server. Populated by the system. Read-only. - // More info: + // ResourceVersion: Opaque string that identifies the server's internal + // version of this object. It can be used by clients to determine when + // objects have changed. If the message is passed back to the server, it + // must be left unmodified. // https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency - // +optional ResourceVersion string `json:"resourceVersion,omitempty"` - // SelfLink: SelfLink is a URL representing this object. Populated by - // the system. Read-only. +optional + // SelfLink: URL representing this object. SelfLink string `json:"selfLink,omitempty"` // ForceSendFields is a list of field names (e.g. "Continue") to @@ -2465,20 +2437,22 @@ func (s *ListRoutesResponse) MarshalJSON() ([]byte, error) { // ListServicesResponse: A list of Service resources. type ListServicesResponse struct { - // ApiVersion: The API version for this call such as + // ApiVersion: The API version for this call; returns // "serving.knative.dev/v1". ApiVersion string `json:"apiVersion,omitempty"` // Items: List of Services. Items []*Service `json:"items,omitempty"` - // Kind: The kind of this resource, in this case "ServiceList". + // Kind: The kind of this resource; returns "ServiceList". Kind string `json:"kind,omitempty"` // Metadata: Metadata associated with this Service list. Metadata *ListMeta `json:"metadata,omitempty"` - // Unreachable: Locations that could not be reached. + // Unreachable: For calls against the global endpoint, returns the list + // of Cloud locations that could not be reached. For regional calls, + // this field is not used. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -2553,11 +2527,11 @@ func (s *ListTasksResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LocalObjectReference: Not supported by Cloud Run LocalObjectReference -// contains enough information to let you locate the referenced object -// inside the same namespace. +// LocalObjectReference: Not supported by Cloud Run. +// LocalObjectReference contains enough information to let you locate +// the referenced object inside the same namespace. type LocalObjectReference struct { - // Name: (Optional) Name of the referent. More info: + // Name: Name of the referent. More info: // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Name string `json:"name,omitempty"` @@ -2634,135 +2608,100 @@ func (s *Location) MarshalJSON() ([]byte, error) { // metadata that all persisted resources must have, which includes all // objects users must create. type ObjectMeta struct { - // Annotations: (Optional) Annotations is an unstructured key value map - // stored with a resource that may be set by external tools to store and - // retrieve arbitrary metadata. They are not queryable and should be - // preserved when modifying objects. More info: + // Annotations: Unstructured key value map stored with a resource that + // may be set by external tools to store and retrieve arbitrary + // metadata. They are not queryable and should be preserved when + // modifying objects. In Cloud Run, annotations with + // 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, + // and the accepted annotations will be different depending on the + // resource type. * `autoscaling.knative.dev/maxScale`: Revision. * + // `autoscaling.knative.dev/minScale`: Revision. * + // `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * + // `run.googleapis.com/binary-authorization`: Service, Job, Execution. * + // `run.googleapis.com/client-name`: All resources. * + // `run.googleapis.com/cloudsql-instances`: Revision, Execution. * + // `run.googleapis.com/cpu-throttling`: Revision. * + // `run.googleapis.com/custom-audiences`: Service. * + // `run.googleapis.com/description`: Service. * + // `run.googleapis.com/encryption-key-shutdown-hours`: Revision * + // `run.googleapis.com/encryption-key`: Revision, Execution. * + // `run.googleapis.com/execution-environment`: Revision, Execution. * + // `run.googleapis.com/gc-traffic-tags`: Service. * + // `run.googleapis.com/ingress`: Service. * + // `run.googleapis.com/network-interfaces`: Revision, Execution. * + // `run.googleapis.com/post-key-revocation-action-type`: Revision. * + // `run.googleapis.com/secrets`: Revision, Execution. * + // `run.googleapis.com/secure-session-agent`: Revision. * + // `run.googleapis.com/sessionAffinity`: Revision. * + // `run.googleapis.com/startup-cpu-boost`: Revision. * + // `run.googleapis.com/vpc-access-connector`: Revision, Execution. * + // `run.googleapis.com/vpc-access-egress`: Revision, Execution. + // Execution. More info: // https://kubernetes.io/docs/user-guide/annotations Annotations map[string]string `json:"annotations,omitempty"` - // ClusterName: (Optional) Not supported by Cloud Run The name of the - // cluster which the object belongs to. This is used to distinguish - // resources with same name and namespace in different clusters. This - // field is not set anywhere right now and apiserver is going to ignore - // it if set in create or update request. + // ClusterName: Not supported by Cloud Run ClusterName string `json:"clusterName,omitempty"` - // CreationTimestamp: (Optional) CreationTimestamp is a timestamp - // representing the server time when this object was created. It is not - // guaranteed to be set in happens-before order across separate - // operations. Clients may not set this value. It is represented in - // RFC3339 form and is in UTC. Populated by the system. Read-only. Null - // for lists. More info: + // CreationTimestamp: UTC timestamp representing the server time when + // this object was created. More info: // https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata CreationTimestamp string `json:"creationTimestamp,omitempty"` - // DeletionGracePeriodSeconds: (Optional) Not supported by Cloud Run - // Number of seconds allowed for this object to gracefully terminate - // before it will be removed from the system. Only set when - // deletionTimestamp is also set. May only be shortened. Read-only. + // DeletionGracePeriodSeconds: Not supported by Cloud Run DeletionGracePeriodSeconds int64 `json:"deletionGracePeriodSeconds,omitempty"` - // DeletionTimestamp: (Optional) Not supported by Cloud Run - // DeletionTimestamp is RFC 3339 date and time at which this resource - // will be deleted. This field is set by the server when a graceful - // deletion is requested by the user, and is not directly settable by a - // client. The resource is expected to be deleted (no longer visible - // from resource lists, and not reachable by name) after the time in - // this field, once the finalizers list is empty. As long as the - // finalizers list contains items, deletion is blocked. Once the - // deletionTimestamp is set, this value may not be unset or be set - // further into the future, although it may be shortened or the resource - // may be deleted prior to this time. For example, a user may request - // that a pod is deleted in 30 seconds. The Kubelet will react by - // sending a graceful termination signal to the containers in the pod. - // After that 30 seconds, the Kubelet will send a hard termination - // signal (SIGKILL) to the container and after cleanup, remove the pod - // from the API. In the presence of network partitions, this object may - // still exist after this timestamp, until an administrator or automated - // process can determine the resource is fully terminated. If not set, - // graceful deletion of the object has not been requested. Populated by - // the system when a graceful deletion is requested. Read-only. More - // info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + // DeletionTimestamp: The read-only soft deletion timestamp for this + // resource. In Cloud Run, users are not able to set this field. + // Instead, they must call the corresponding Delete API. DeletionTimestamp string `json:"deletionTimestamp,omitempty"` - // Finalizers: (Optional) Not supported by Cloud Run Must be empty - // before the object is deleted from the registry. Each entry is an - // identifier for the responsible component that will remove the entry - // from the list. If the deletionTimestamp of the object is non-nil, - // entries in this list can only be removed. +patchStrategy=merge + // Finalizers: Not supported by Cloud Run Finalizers []string `json:"finalizers,omitempty"` - // GenerateName: (Optional) Not supported by Cloud Run GenerateName is - // an optional prefix, used by the server, to generate a unique name - // ONLY IF the Name field has not been provided. If this field is used, - // the name returned to the client will be different than the name - // passed. This value will also be combined with a unique suffix. The - // provided value has the same validation rules as the Name field, and - // may be truncated by the length of the suffix required to make the - // value unique on the server. If this field is specified and the - // generated name exists, the server will NOT return a 409 - instead, it - // will either return 201 Created or 500 with Reason ServerTimeout - // indicating a unique name could not be found in the time allotted, and - // the client should retry (optionally after the time indicated in the - // Retry-After header). Applied only if Name is not specified. More - // info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency - // string generateName = 2; + // GenerateName: Not supported by Cloud Run GenerateName string `json:"generateName,omitempty"` - // Generation: (Optional) A sequence number representing a specific - // generation of the desired state. Populated by the system. Read-only. + // Generation: A system-provided sequence number representing a specific + // generation of the desired state. Generation int64 `json:"generation,omitempty"` - // Labels: (Optional) Map of string keys and values that can be used to - // organize and categorize (scope and select) objects. May match - // selectors of replication controllers and routes. More info: + // Labels: Map of string keys and values that can be used to organize + // and categorize (scope and select) objects. May match selectors of + // replication controllers and routes. More info: // https://kubernetes.io/docs/user-guide/labels Labels map[string]string `json:"labels,omitempty"` - // Name: Name must be unique within a namespace, within a Cloud Run - // region. Is required when creating resources, although some resources - // may allow a client to request the generation of an appropriate name - // automatically. Name is primarily intended for creation idempotence - // and configuration definition. Cannot be updated. More info: + // Name: The immutable name of the resource. In Cloud Run, name is + // required when creating top-level resources (Service, Job), and must + // be unique within a Cloud Run project/region. More info: // https://kubernetes.io/docs/user-guide/identifiers#names If ObjectMeta - // is part of a namespaces.services.create request, name must contain - // fewer than 50 characters. +optional + // is part of a CreateServiceRequest, name must contain fewer than 50 + // characters. Otherwise, Name string `json:"name,omitempty"` - // Namespace: Namespace defines the space within each name must be - // unique, within a Cloud Run region. In Cloud Run the namespace must be - // equal to either the project ID or project number. + // Namespace: Defines the space within each name must be unique within a + // Cloud Run region. In Cloud Run, it must be project ID or number. Namespace string `json:"namespace,omitempty"` - // OwnerReferences: (Optional) Not supported by Cloud Run List of - // objects that own this object. If ALL objects in the list have been - // deleted, this object will be garbage collected. + // OwnerReferences: Not supported by Cloud Run OwnerReferences []*OwnerReference `json:"ownerReferences,omitempty"` - // ResourceVersion: Optional. An opaque value that represents the - // internal version of this object that can be used by clients to - // determine when objects have changed. May be used for optimistic - // concurrency, change detection, and the watch operation on a resource - // or set of resources. Clients must treat these values as opaque and - // passed unmodified back to the server or omit the value to disable - // conflict-detection. They may only be valid for a particular resource - // or set of resources. Populated by the system. Read-only. Value must - // be treated as opaque by clients or omitted. More info: + // ResourceVersion: Optional. Opaque, system-generated value that + // represents the internal version of this object that can be used by + // clients to determine when objects have changed. May be used for + // optimistic concurrency, change detection, and the watch operation on + // a resource or set of resources. Clients must treat these values as + // opaque and passed unmodified back to the server or omit the value to + // disable conflict-detection. More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency ResourceVersion string `json:"resourceVersion,omitempty"` - // SelfLink: (Optional) SelfLink is a URL representing this object. - // Populated by the system. Read-only. string selfLink = 4; + // SelfLink: URL representing this object. SelfLink string `json:"selfLink,omitempty"` - // Uid: (Optional) UID is the unique in time and space value for this - // object. It is typically generated by the server on successful - // creation of a resource and is not allowed to change on PUT - // operations. Populated by the system. Read-only. More info: - // https://kubernetes.io/docs/user-guide/identifiers#uids + // Uid: Unique, system-generated identifier for this resource. More + // info: https://kubernetes.io/docs/user-guide/identifiers#uids Uid string `json:"uid,omitempty"` // ForceSendFields is a list of field names (e.g. "Annotations") to @@ -2788,35 +2727,24 @@ func (s *ObjectMeta) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// OwnerReference: OwnerReference contains enough information to let you -// identify an owning object. Currently, an owning object must be in the -// same namespace, so there is no namespace field. +// OwnerReference: This is not supported or used by Cloud Run. type OwnerReference struct { - // ApiVersion: API version of the referent. + // ApiVersion: This is not supported or used by Cloud Run. ApiVersion string `json:"apiVersion,omitempty"` - // BlockOwnerDeletion: If true, AND if the owner has the - // "foregroundDeletion" finalizer, then the owner cannot be deleted from - // the key-value store until this reference is removed. Defaults to - // false. To set this field, a user needs "delete" permission of the - // owner, otherwise 422 (Unprocessable Entity) will be returned. - // +optional + // BlockOwnerDeletion: This is not supported or used by Cloud Run. BlockOwnerDeletion bool `json:"blockOwnerDeletion,omitempty"` - // Controller: If true, this reference points to the managing - // controller. +optional + // Controller: This is not supported or used by Cloud Run. Controller bool `json:"controller,omitempty"` - // Kind: Kind of the referent. More info: - // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + // Kind: This is not supported or used by Cloud Run. Kind string `json:"kind,omitempty"` - // Name: Name of the referent. More info: - // https://kubernetes.io/docs/user-guide/identifiers#names + // Name: This is not supported or used by Cloud Run. Name string `json:"name,omitempty"` - // Uid: UID of the referent. More info: - // https://kubernetes.io/docs/user-guide/identifiers#uids + // Uid: This is not supported or used by Cloud Run. Uid string `json:"uid,omitempty"` // ForceSendFields is a list of field names (e.g. "ApiVersion") to @@ -2952,54 +2880,47 @@ func (s *Policy) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Probe: Not supported by Cloud Run Probe describes a health check to -// be performed against a container to determine whether it is alive or -// ready to receive traffic. +// Probe: Probe describes a health check to be performed against a +// container to determine whether it is alive or ready to receive +// traffic. type Probe struct { - // Exec: (Optional) Not supported by Cloud Run One and only one of the - // following should be specified. Exec specifies the action to take. A - // field inlined from the Handler message. + // Exec: Not supported by Cloud Run. Exec *ExecAction `json:"exec,omitempty"` - // FailureThreshold: (Optional) Minimum consecutive failures for the - // probe to be considered failed after having succeeded. Defaults to 3. - // Minimum value is 1. + // FailureThreshold: Minimum consecutive failures for the probe to be + // considered failed after having succeeded. Defaults to 3. Minimum + // value is 1. FailureThreshold int64 `json:"failureThreshold,omitempty"` - // Grpc: (Optional) GRPCAction specifies an action involving a GRPC - // port. A field inlined from the Handler message. + // Grpc: GRPCAction specifies an action involving a GRPC port. Grpc *GRPCAction `json:"grpc,omitempty"` - // HttpGet: (Optional) HTTPGet specifies the http request to perform. A - // field inlined from the Handler message. + // HttpGet: HTTPGet specifies the http request to perform. HttpGet *HTTPGetAction `json:"httpGet,omitempty"` - // InitialDelaySeconds: (Optional) Number of seconds after the container - // has started before the probe is initiated. Defaults to 0 seconds. - // Minimum value is 0. Maximum value for liveness probe is 3600. Maximum - // value for startup probe is 240. More info: + // InitialDelaySeconds: Number of seconds after the container has + // started before the probe is initiated. Defaults to 0 seconds. Minimum + // value is 0. Maximum value for liveness probe is 3600. Maximum value + // for startup probe is 240. More info: // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes InitialDelaySeconds int64 `json:"initialDelaySeconds,omitempty"` - // PeriodSeconds: (Optional) How often (in seconds) to perform the - // probe. Default to 10 seconds. Minimum value is 1. Maximum value for - // liveness probe is 3600. Maximum value for startup probe is 240. Must - // be greater or equal than timeout_seconds. + // PeriodSeconds: How often (in seconds) to perform the probe. Default + // to 10 seconds. Minimum value is 1. Maximum value for liveness probe + // is 3600. Maximum value for startup probe is 240. Must be greater or + // equal than timeout_seconds. PeriodSeconds int64 `json:"periodSeconds,omitempty"` - // SuccessThreshold: (Optional) Minimum consecutive successes for the - // probe to be considered successful after having failed. Must be 1 if - // set. + // SuccessThreshold: Minimum consecutive successes for the probe to be + // considered successful after having failed. Must be 1 if set. SuccessThreshold int64 `json:"successThreshold,omitempty"` - // TcpSocket: (Optional) TCPSocket specifies an action involving a TCP - // port. TCP hooks not yet supported A field inlined from the Handler - // message. + // TcpSocket: TCPSocket specifies an action involving a TCP port. TcpSocket *TCPSocketAction `json:"tcpSocket,omitempty"` - // TimeoutSeconds: (Optional) Number of seconds after which the probe - // times out. Defaults to 1 second. Minimum value is 1. Maximum value is - // 3600. Must be smaller than period_seconds. More info: + // TimeoutSeconds: Number of seconds after which the probe times out. + // Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must + // be smaller than period_seconds. More info: // https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes TimeoutSeconds int64 `json:"timeoutSeconds,omitempty"` @@ -3072,17 +2993,17 @@ func (s *ResourceRecord) MarshalJSON() ([]byte, error) { // ResourceRequirements: ResourceRequirements describes the compute // resource requirements. type ResourceRequirements struct { - // Limits: (Optional) Only memory and CPU are supported. Limits - // describes the maximum amount of compute resources allowed. The values - // of the map is string form of the 'quantity' k8s type: + // Limits: Only memory and CPU are supported. Limits describes the + // maximum amount of compute resources allowed. The values of the map is + // string form of the 'quantity' k8s type: // https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go Limits map[string]string `json:"limits,omitempty"` - // Requests: (Optional) Only memory and CPU are supported. Requests - // describes the minimum amount of compute resources required. If - // Requests is omitted for a container, it defaults to Limits if that is - // explicitly specified, otherwise to an implementation-defined value. - // The values of the map is string form of the 'quantity' k8s type: + // Requests: Only memory and CPU are supported. Requests describes the + // minimum amount of compute resources required. If Requests is omitted + // for a container, it defaults to Limits if that is explicitly + // specified, otherwise to an implementation-defined value. The values + // of the map is string form of the 'quantity' k8s type: // https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go Requests map[string]string `json:"requests,omitempty"` @@ -3112,7 +3033,7 @@ func (s *ResourceRequirements) MarshalJSON() ([]byte, error) { // Revision: Revision is an immutable snapshot of code and // configuration. A revision references a container image. Revisions are // created by updates to a Configuration. See also: -// https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision +// https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision type Revision struct { // ApiVersion: The API version for this call such as // "serving.knative.dev/v1". @@ -3164,10 +3085,7 @@ func (s *Revision) MarshalJSON() ([]byte, error) { type RevisionSpec struct { // ContainerConcurrency: ContainerConcurrency specifies the maximum // allowed in-flight (concurrent) requests per container instance of the - // Revision. Cloud Run fully managed: supported, defaults to 80 Cloud - // Run for Anthos: supported, defaults to 0, which means concurrency to - // the application is not limited, and the system decides the target - // concurrency for the autoscaler. + // Revision. Cloud Run: supported, defaults to 80 ContainerConcurrency int64 `json:"containerConcurrency,omitempty"` // Containers: Containers holds the single container that defines the @@ -3175,23 +3093,13 @@ type RevisionSpec struct { // disallow a number of fields on this Container, including: name and // lifecycle. In Cloud Run, only a single container may be provided. The // runtime contract is documented here: - // https://github.com/knative/serving/blob/main/docs/runtime-contract.md + // https://github.com/knative/specs/blob/main/specs/serving/runtime-contract.md Containers []*Container `json:"containers,omitempty"` - // EnableServiceLinks: Indicates whether information about services - // should be injected into pod's environment variables, matching the - // syntax of Docker links. Cloud Run fully managed: Not supported. Cloud - // Run for Anthos: supported, defaults to true. + // EnableServiceLinks: Not supported by Cloud Run. EnableServiceLinks bool `json:"enableServiceLinks,omitempty"` - // ImagePullSecrets: ImagePullSecrets is a list of references to secrets - // in the same namespace to use for pulling any images in pods that - // reference this ServiceAccount. ImagePullSecrets are distinct from - // Secrets because Secrets can be mounted in the pod, but - // ImagePullSecrets are only accessed by the kubelet. More info: - // https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod - // Cloud Run fully managed: Not supported. Cloud Run for Anthos: - // supported. + // ImagePullSecrets: Not supported by Cloud Run. ImagePullSecrets []*LocalObjectReference `json:"imagePullSecrets,omitempty"` // ServiceAccountName: Email address of the IAM service account @@ -3202,11 +3110,8 @@ type RevisionSpec struct { ServiceAccountName string `json:"serviceAccountName,omitempty"` // TimeoutSeconds: TimeoutSeconds holds the max duration the instance is - // allowed for responding to a request. Cloud Run fully managed: - // defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 - // seconds (1 hour). Cloud Run for Anthos: defaults to 300 seconds (5 - // minutes). Maximum allowed value is configurable by the cluster - // operator. + // allowed for responding to a request. Cloud Run: defaults to 300 + // seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour). TimeoutSeconds int64 `json:"timeoutSeconds,omitempty"` Volumes []*Volume `json:"volumes,omitempty"` @@ -3346,7 +3251,7 @@ func (s *RevisionTemplate) MarshalJSON() ([]byte, error) { // creating them; in these cases the Route is additionally responsible // for monitoring the Configuration for "latest ready" revision changes, // and smoothly rolling out latest revisions. See also: -// https://github.com/knative/serving/blob/main/docs/spec/overview.md#route +// https://github.com/knative/specs/blob/main/specs/serving/overview.md#route // Cloud Run currently supports referencing a single Configuration to // automatically deploy the "latest ready" Revision from that // Configuration. @@ -3453,7 +3358,7 @@ type RouteStatus struct { // Traffic: Traffic holds the configured traffic distribution. These // entries will always contain RevisionName references. When // ConfigurationName appears in the spec, this will hold the - // LatestReadyRevisionName that we last observed. + // LatestReadyRevisionName that was last observed. Traffic []*TrafficTarget `json:"traffic,omitempty"` // Url: URL holds the url that will distribute traffic over the provided @@ -3488,8 +3393,8 @@ func (s *RouteStatus) MarshalJSON() ([]byte, error) { type RunJobRequest struct { } -// SecretEnvSource: Not supported by Cloud Run SecretEnvSource selects a -// Secret to populate the environment variables with. The contents of +// SecretEnvSource: Not supported by Cloud Run. SecretEnvSource selects +// a Secret to populate the environment variables with. The contents of // the target Secret's Data field will represent the key-value pairs as // environment variables. type SecretEnvSource struct { @@ -3501,7 +3406,7 @@ type SecretEnvSource struct { // Name: The Secret to select from. Name string `json:"name,omitempty"` - // Optional: (Optional) Specify whether the Secret must be defined + // Optional: Specify whether the Secret must be defined Optional bool `json:"optional,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -3531,9 +3436,9 @@ func (s *SecretEnvSource) MarshalJSON() ([]byte, error) { // SecretKeySelector: SecretKeySelector selects a key of a Secret. type SecretKeySelector struct { - // Key: A Cloud Secret Manager secret version. Must be 'latest' for the - // latest version or an integer for a specific version. The key of the - // secret to select from. Must be a valid secret key. + // Key: Required. A Cloud Secret Manager secret version. Must be + // 'latest' for the latest version or an integer for a specific version. + // The key of the secret to select from. Must be a valid secret key. Key string `json:"key,omitempty"` // LocalObjectReference: This field should not be used directly as it is @@ -3550,8 +3455,7 @@ type SecretKeySelector struct { // secret in the pod's namespace to select from. Name string `json:"name,omitempty"` - // Optional: (Optional) Specify whether the Secret or its key must be - // defined + // Optional: Specify whether the Secret or its key must be defined. Optional bool `json:"optional,omitempty"` // ForceSendFields is a list of field names (e.g. "Key") to @@ -3577,10 +3481,11 @@ func (s *SecretKeySelector) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// SecretVolumeSource: The secret's value will be presented as the -// content of a file whose name is defined in the item path. If no items -// are defined, the name of the file is the secret_name. The contents of -// the target Secret's Data field will be presented in a volume as files +// SecretVolumeSource: A volume representing a secret stored in Google +// Secret Manager. The secret's value will be presented as the content +// of a file whose name is defined in the item path. If no items are +// defined, the name of the file is the secret_name. The contents of the +// target Secret's Data field will be presented in a volume as files // using the keys in the Data field as the file names. type SecretVolumeSource struct { // DefaultMode: Integer representation of mode bits to use on created @@ -3598,21 +3503,16 @@ type SecretVolumeSource struct { // bits set. DefaultMode int64 `json:"defaultMode,omitempty"` - // Items: (Optional) If unspecified, the volume will expose a file whose - // name is the secret_name. If specified, the key will be used as the - // version to fetch from Cloud Secret Manager and the path will be the - // name of the file exposed in the volume. When items are defined, they - // must specify a key and a path. If unspecified, each key-value pair in - // the Data field of the referenced Secret will be projected into the - // volume as a file whose name is the key and content is the value. If - // specified, the listed keys will be projected into the specified - // paths, and unlisted keys will not be present. If a key is specified - // that is not present in the Secret, the volume setup will error unless - // it is marked optional. + // Items: A list of secret versions to mount in the volume. If no items + // are specified, the volume will expose a file with the same name as + // the secret name. The contents of the file will be the data in the + // latest version of the secret. If items are specified, the key will be + // used as the version to fetch from Cloud Secret Manager and the path + // will be the name of the file exposed in the volume. When items are + // defined, they must specify both a key and a path. Items []*KeyToPath `json:"items,omitempty"` - // Optional: (Optional) Specify whether the Secret or its keys must be - // defined. + // Optional: Not supported by Cloud Run. Optional bool `json:"optional,omitempty"` // SecretName: The name of the secret in Cloud Secret Manager. By @@ -3647,15 +3547,15 @@ func (s *SecretVolumeSource) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// SecurityContext: Not supported by Cloud Run SecurityContext holds +// SecurityContext: Not supported by Cloud Run. SecurityContext holds // security configuration that will be applied to a container. Some // fields are present in both SecurityContext and PodSecurityContext. // When both are set, the values in SecurityContext take precedence. type SecurityContext struct { - // RunAsUser: (Optional) The UID to run the entrypoint of the container - // process. Defaults to user specified in image metadata if unspecified. - // May also be set in PodSecurityContext. If set in both SecurityContext - // and PodSecurityContext, the value specified in SecurityContext takes + // RunAsUser: The UID to run the entrypoint of the container process. + // Defaults to user specified in image metadata if unspecified. May also + // be set in PodSecurityContext. If set in both SecurityContext and + // PodSecurityContext, the value specified in SecurityContext takes // precedence. RunAsUser int64 `json:"runAsUser,omitempty"` @@ -3694,16 +3594,25 @@ func (s *SecurityContext) MarshalJSON() ([]byte, error) { // conditions as its own. See also: // https://github.com/knative/serving/blob/main/docs/spec/overview.md#service type Service struct { - // ApiVersion: The API version for this call such as + // ApiVersion: The API version for this call. It must be // "serving.knative.dev/v1". ApiVersion string `json:"apiVersion,omitempty"` - // Kind: The kind of resource, in this case "Service". + // Kind: The kind of resource. It must be "Service". Kind string `json:"kind,omitempty"` // Metadata: Metadata associated with this Service, including name, - // namespace, labels, and annotations. Cloud Run (fully managed) uses - // the following annotation keys to configure features on a Service: * + // namespace, labels, and annotations. In Cloud Run, annotations with + // 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, + // and the accepted annotations will be different depending on the + // resource type. The following Cloud Run-specific annotations are + // accepted in Service.metadata.annotations. * + // `run.googleapis.com/binary-authorization-breakglass` * + // `run.googleapis.com/binary-authorization` * + // `run.googleapis.com/client-name` * + // `run.googleapis.com/custom-audiences` * + // `run.googleapis.com/description` * + // `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * // `run.googleapis.com/ingress` sets the ingress settings for the // Service. See the ingress settings documentation // (/run/docs/securing/ingress) for details on configuring ingress @@ -3717,11 +3626,10 @@ type Service struct { // `run.googleapis.com/ingress` are equal. Metadata *ObjectMeta `json:"metadata,omitempty"` - // Spec: Spec holds the desired state of the Service (from the client). + // Spec: Holds the desired state of the Service (from the client). Spec *ServiceSpec `json:"spec,omitempty"` - // Status: Status communicates the observed state of the Service (from - // the controller). + // Status: Communicates the system-controlled state of the Service. Status *ServiceStatus `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3755,12 +3663,12 @@ func (s *Service) MarshalJSON() ([]byte, error) { // the client), which is used to manipulate the underlying Route and // Configuration(s). type ServiceSpec struct { - // Template: Template holds the latest specification for the Revision to - // be stamped out. + // Template: Holds the latest specification for the Revision to be + // stamped out. Template *RevisionTemplate `json:"template,omitempty"` - // Traffic: Traffic specifies how to distribute traffic over a - // collection of Knative Revisions and Configurations. + // Traffic: Specifies how to distribute traffic over a collection of + // Knative Revisions and Configurations to the Service's main URL. Traffic []*TrafficTarget `json:"traffic,omitempty"` // ForceSendFields is a list of field names (e.g. "Template") to @@ -3788,46 +3696,44 @@ func (s *ServiceSpec) MarshalJSON() ([]byte, error) { // ServiceStatus: The current state of the Service. Output only. type ServiceStatus struct { - // Address: From RouteStatus. Similar to url, information on where the - // service is available on HTTP. + // Address: Similar to url, information on where the service is + // available on HTTP. Address *Addressable `json:"address,omitempty"` - // Conditions: Conditions communicates information about - // ongoing/complete reconciliation processes that bring the "spec" - // inline with the observed state of the world. Service-specific - // conditions include: * "ConfigurationsReady": true when the underlying - // Configuration is ready. * "RoutesReady": true when the underlying - // Route is ready. * "Ready": true when both the underlying Route and - // Configuration are ready. + // Conditions: Communicates information about ongoing/complete + // reconciliation processes that bring the `spec` inline with the + // observed state of the world. Service-specific conditions include: * + // `ConfigurationsReady`: `True` when the underlying Configuration is + // ready. * `RoutesReady`: `True` when the underlying Route is ready. * + // `Ready`: `True` when all underlying resources are ready. Conditions []*GoogleCloudRunV1Condition `json:"conditions,omitempty"` - // LatestCreatedRevisionName: From ConfigurationStatus. - // LatestCreatedRevisionName is the last revision that was created from - // this Service's Configuration. It might not be ready yet, for that use - // LatestReadyRevisionName. + // LatestCreatedRevisionName: Name of the last revision that was created + // from this Service's Configuration. It might not be ready yet, for + // that use LatestReadyRevisionName. LatestCreatedRevisionName string `json:"latestCreatedRevisionName,omitempty"` - // LatestReadyRevisionName: From ConfigurationStatus. - // LatestReadyRevisionName holds the name of the latest Revision stamped - // out from this Service's Configuration that has had its "Ready" - // condition become "True". + // LatestReadyRevisionName: Name of the latest Revision from this + // Service's Configuration that has had its `Ready` condition become + // `True`. LatestReadyRevisionName string `json:"latestReadyRevisionName,omitempty"` - // ObservedGeneration: ObservedGeneration is the 'Generation' of the - // Route that was last processed by the controller. Clients polling for - // completed reconciliation should poll until observedGeneration = + // ObservedGeneration: Returns the generation last fully processed by + // the system. This will only match metadata.generation when + // reconciliation is complete. Clients polling for completed + // reconciliation should poll until observedGeneration = // metadata.generation and the Ready condition's status is True or // False. ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // Traffic: From RouteStatus. Traffic holds the configured traffic - // distribution. These entries will always contain RevisionName - // references. When ConfigurationName appears in the spec, this will - // hold the LatestReadyRevisionName that we last observed. + // Traffic: Holds the configured traffic distribution. These entries + // will always contain RevisionName references. When ConfigurationName + // appears in the spec, this will hold the LatestReadyRevisionName that + // we last observed. Traffic []*TrafficTarget `json:"traffic,omitempty"` - // Url: From RouteStatus. URL holds the url that will distribute traffic - // over the provided traffic targets. It generally has the form + // Url: URL that will distribute traffic over the provided traffic + // targets. It generally has the form // https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app Url string `json:"url,omitempty"` @@ -3892,37 +3798,34 @@ func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error) { } // Status: Status is a return value for calls that don't return other -// objects +// objects. type Status struct { // Code: Suggested HTTP return code for this status, 0 if not set. - // +optional Code int64 `json:"code,omitempty"` // Details: Extended data associated with the reason. Each reason may // define its own extended details. This field is optional and the data // returned is not guaranteed to conform to any schema except that - // defined by the reason type. +optional + // defined by the reason type. Details *StatusDetails `json:"details,omitempty"` // Message: A human-readable description of the status of this - // operation. +optional + // operation. Message string `json:"message,omitempty"` // Metadata: Standard list metadata. More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - // +optional Metadata *ListMeta `json:"metadata,omitempty"` // Reason: A machine-readable description of why this operation is in // the "Failure" status. If this value is empty there is no information // available. A Reason clarifies an HTTP status code but does not - // override it. +optional + // override it. Reason string `json:"reason,omitempty"` // Status: Status of the operation. One of: "Success" or "Failure". More // info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - // +optional Status string `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -3960,17 +3863,17 @@ type StatusCause struct { // by its JSON serialization. May include dot and postfix notation for // nested attributes. Arrays are zero-indexed. Fields may appear more // than once in an array of causes due to fields having multiple errors. - // Optional. Examples: "name" - the field "name" on the current resource + // Examples: "name" - the field "name" on the current resource // "items[0].name" - the field "name" on the first array entry in - // "items" +optional + // "items" Field string `json:"field,omitempty"` // Message: A human-readable description of the cause of the error. This - // field may be presented as-is to a reader. +optional + // field may be presented as-is to a reader. Message string `json:"message,omitempty"` // Reason: A machine-readable description of the cause of the error. If - // this value is empty there is no information available. +optional + // this value is empty there is no information available. Reason string `json:"reason,omitempty"` // ForceSendFields is a list of field names (e.g. "Field") to @@ -4005,34 +3908,32 @@ func (s *StatusCause) MarshalJSON() ([]byte, error) { type StatusDetails struct { // Causes: The Causes array includes more details associated with the // StatusReason failure. Not all StatusReasons may provide detailed - // causes. +optional + // causes. Causes []*StatusCause `json:"causes,omitempty"` // Group: The group attribute of the resource associated with the status - // StatusReason. +optional + // StatusReason. Group string `json:"group,omitempty"` // Kind: The kind attribute of the resource associated with the status // StatusReason. On some operations may differ from the requested // resource Kind. More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - // +optional Kind string `json:"kind,omitempty"` // Name: The name attribute of the resource associated with the status // StatusReason (when there is a single name which can be described). - // +optional Name string `json:"name,omitempty"` // RetryAfterSeconds: If specified, the time in seconds before the // operation should be retried. Some errors may indicate the client must // take an alternate action - for those errors this field may indicate - // how long to wait before taking the alternate action. +optional + // how long to wait before taking the alternate action. RetryAfterSeconds int64 `json:"retryAfterSeconds,omitempty"` // Uid: UID of the resource. (when there is a single resource which can // be described). More info: - // https://kubernetes.io/docs/user-guide/identifiers#uids +optional + // https://kubernetes.io/docs/user-guide/identifiers#uids Uid string `json:"uid,omitempty"` // ForceSendFields is a list of field names (e.g. "Causes") to @@ -4061,14 +3962,11 @@ func (s *StatusDetails) MarshalJSON() ([]byte, error) { // TCPSocketAction: TCPSocketAction describes an action based on opening // a socket type TCPSocketAction struct { - // Host: (Optional) Optional: Host name to connect to, defaults to the - // pod IP. + // Host: Not supported by Cloud Run. Host string `json:"host,omitempty"` - // Port: Number or name of the port to access on the container. Number - // must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. This - // field is currently limited to integer types only because of proto's - // inability to properly support the IntOrString golang type. + // Port: Port number to access on the container. Number must be in the + // range 1 to 65535. Port int64 `json:"port,omitempty"` // ForceSendFields is a list of field names (e.g. "Host") to @@ -4101,7 +3999,6 @@ type Task struct { // schemas to the latest internal value, and may reject unrecognized // values. More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - // +optional ApiVersion string `json:"apiVersion,omitempty"` // Kind: Optional. Kind is a string value representing the REST resource @@ -4109,23 +4006,19 @@ type Task struct { // client submits requests to. Cannot be updated. In CamelCase. More // info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - // +optional Kind string `json:"kind,omitempty"` // Metadata: Optional. Standard object's metadata. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - // +optional + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Metadata *ObjectMeta `json:"metadata,omitempty"` - // Spec: Optional. Specification of the desired behavior of an - // execution. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - // +optional + // Spec: Optional. Specification of the desired behavior of a task. More + // info: + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec *TaskSpec `json:"spec,omitempty"` - // Status: Output only. Current status of an execution. More info: - // https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - // +optional + // Status: Output only. Current status of a task. More info: + // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Status *TaskStatus `json:"status,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -4204,18 +4097,18 @@ type TaskSpec struct { // account associated with the task of a job execution. The service // account represents the identity of the running task, and determines // what permissions the task has. If not provided, the task will use the - // project's default service account. +optional + // project's default service account. ServiceAccountName string `json:"serviceAccountName,omitempty"` - // TimeoutSeconds: Optional. Optional duration in seconds the task may - // be active before the system will actively try to mark it failed and - // kill associated containers. This applies per attempt of a task, - // meaning each retry can run for the full timeout. +optional + // TimeoutSeconds: Optional. Duration in seconds the task may be active + // before the system will actively try to mark it failed and kill + // associated containers. This applies per attempt of a task, meaning + // each retry can run for the full timeout. TimeoutSeconds int64 `json:"timeoutSeconds,omitempty,string"` // Volumes: Optional. List of volumes that can be mounted by containers // belonging to the task. More info: - // https://kubernetes.io/docs/concepts/storage/volumes +optional + // https://kubernetes.io/docs/concepts/storage/volumes Volumes []*Volume `json:"volumes,omitempty"` // ForceSendFields is a list of field names (e.g. "Containers") to @@ -4241,19 +4134,17 @@ func (s *TaskSpec) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TaskStatus: TaskStatus represents the status of a task of a job -// execution. +// TaskStatus: TaskStatus represents the status of a task. type TaskStatus struct { // CompletionTime: Optional. Represents time when the task was // completed. It is not guaranteed to be set in happens-before order // across separate operations. It is represented in RFC3339 form and is - // in UTC. +optional + // in UTC. CompletionTime string `json:"completionTime,omitempty"` // Conditions: Optional. The latest available observations of a task's // current state. More info: - // https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ - // +optional + // https://kubernetes.io/docs/concepts/workloads/controllers/job/ Conditions []*GoogleCloudRunV1Condition `json:"conditions,omitempty"` // Index: Required. Index of the task, unique per execution, and @@ -4261,26 +4152,23 @@ type TaskStatus struct { Index int64 `json:"index,omitempty"` // LastAttemptResult: Optional. Result of the last attempt of this task. - // +optional LastAttemptResult *TaskAttemptResult `json:"lastAttemptResult,omitempty"` // LogUri: Optional. URI where logs for this task can be found in Cloud // Console. LogUri string `json:"logUri,omitempty"` - // ObservedGeneration: Optional. The 'generation' of the execution that - // was last processed by the controller. + // ObservedGeneration: Optional. The 'generation' of the task that was + // last processed by the controller. ObservedGeneration int64 `json:"observedGeneration,omitempty"` // Retried: Optional. The number of times this task was retried. // Instances are retried when they fail up to the maxRetries limit. - // +optional Retried int64 `json:"retried,omitempty"` // StartTime: Optional. Represents time when the task started to run. It // is not guaranteed to be set in happens-before order across separate // operations. It is represented in RFC3339 form and is in UTC. - // +optional StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CompletionTime") to @@ -4313,7 +4201,6 @@ type TaskTemplateSpec struct { // Spec: Optional. Specification of the desired behavior of the task. // More info: // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - // +optional Spec *TaskSpec `json:"spec,omitempty"` // ForceSendFields is a list of field names (e.g. "Spec") to @@ -4409,9 +4296,9 @@ func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) { // table for a Route. type TrafficTarget struct { // ConfigurationName: ConfigurationName of a configuration to whose - // latest revision we will send this portion of traffic. When the + // latest revision which will be sent this portion of traffic. When the // "status.latestReadyRevisionName" of the referenced configuration - // changes, we will automatically migrate traffic from the prior "latest + // changes, traffic will automatically migrate from the prior "latest // ready" revision to the new one. This field is never set in Route's // status, only its spec. This is mutually exclusive with RevisionName. // Cloud Run currently supports a single ConfigurationName. @@ -4469,12 +4356,19 @@ func (s *TrafficTarget) MarshalJSON() ([]byte, error) { // Volume: Volume represents a named volume in a container. type Volume struct { + // ConfigMap: Adapts a ConfigMap into a volume. The contents of the + // target ConfigMap's Data field will be presented in a volume as files + // using the keys in the Data field as the file names, unless the items + // element is populated with specific mappings of keys to paths. ConfigMap *ConfigMapVolumeSource `json:"configMap,omitempty"` // Name: Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' // is reserved. Name string `json:"name,omitempty"` + // Secret: The secret's value will be presented as the content of a file + // whose name is defined in the item path. If no items are defined, the + // name of the file is the secretName. Secret *SecretVolumeSource `json:"secret,omitempty"` // ForceSendFields is a list of field names (e.g. "ConfigMap") to @@ -4503,19 +4397,20 @@ func (s *Volume) MarshalJSON() ([]byte, error) { // VolumeMount: VolumeMount describes a mounting of a Volume within a // container. type VolumeMount struct { - // MountPath: Path within the container at which the volume should be - // mounted. Must not contain ':'. + // MountPath: Required. Path within the container at which the volume + // should be mounted. Must not contain ':'. MountPath string `json:"mountPath,omitempty"` - // Name: The name of the volume. There must be a corresponding Volume - // with the same name. + // Name: Required. The name of the volume. There must be a corresponding + // Volume with the same name. Name string `json:"name,omitempty"` - // ReadOnly: (Optional) Only true is accepted. Defaults to true. + // ReadOnly: Only true is accepted for Secret Volumes. Defaults to true + // for Secrets Volumes. ReadOnly bool `json:"readOnly,omitempty"` - // SubPath: (Optional) Path within the volume from which the container's - // volume should be mounted. Defaults to "" (volume's root). + // SubPath: Path within the volume from which the container's volume + // should be mounted. Defaults to "" (volume's root). SubPath string `json:"subPath,omitempty"` // ForceSendFields is a list of field names (e.g. "MountPath") to @@ -4747,9 +4642,8 @@ type NamespacesConfigurationsGetCall struct { // Get: Get information about a configuration. // -// - name: The name of the configuration to retrieve. For Cloud Run -// (fully managed), replace {namespace_id} with the project ID or -// number. +// - name: The name of the configuration to retrieve. For Cloud Run, +// replace {namespace_id} with the project ID or number. func (r *NamespacesConfigurationsService) Get(name string) *NamespacesConfigurationsGetCall { c := &NamespacesConfigurationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -4864,7 +4758,7 @@ func (c *NamespacesConfigurationsGetCall) Do(opts ...googleapi.CallOption) (*Con // ], // "parameters": { // "name": { - // "description": "The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + // "description": "The name of the configuration to retrieve. For Cloud Run, replace {namespace_id} with the project ID or number.", // "location": "path", // "pattern": "^namespaces/[^/]+/configurations/[^/]+$", // "required": true, @@ -4896,8 +4790,8 @@ type NamespacesConfigurationsListCall struct { // List: List configurations. // // - parent: The namespace from which the configurations should be -// listed. For Cloud Run (fully managed), replace {namespace_id} with -// the project ID or number. +// listed. For Cloud Run, replace {namespace_id} with the project ID +// or number. func (r *NamespacesConfigurationsService) List(parent string) *NamespacesConfigurationsListCall { c := &NamespacesConfigurationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -4911,17 +4805,15 @@ func (c *NamespacesConfigurationsListCall) Continue(continue_ string) *Namespace return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported by Cloud Run. func (c *NamespacesConfigurationsListCall) FieldSelector(fieldSelector string) *NamespacesConfigurationsListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported by Cloud Run. func (c *NamespacesConfigurationsListCall) IncludeUninitialized(includeUninitialized bool) *NamespacesConfigurationsListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -4935,24 +4827,22 @@ func (c *NamespacesConfigurationsListCall) LabelSelector(labelSelector string) * return c } -// Limit sets the optional parameter "limit": The maximum number of +// Limit sets the optional parameter "limit": The maximum number of the // records that should be returned. func (c *NamespacesConfigurationsListCall) Limit(limit int64) *NamespacesConfigurationsListCall { c.urlParams_.Set("limit", fmt.Sprint(limit)) return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported by Cloud Run. func (c *NamespacesConfigurationsListCall) ResourceVersion(resourceVersion string) *NamespacesConfigurationsListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used -// by Cloud Run. +// Watch sets the optional parameter "watch": Not supported by Cloud +// Run. func (c *NamespacesConfigurationsListCall) Watch(watch bool) *NamespacesConfigurationsListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) return c @@ -5071,12 +4961,12 @@ func (c *NamespacesConfigurationsListCall) Do(opts ...googleapi.CallOption) (*Li // "type": "string" // }, // "fieldSelector": { - // "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -5086,25 +4976,25 @@ func (c *NamespacesConfigurationsListCall) Do(opts ...googleapi.CallOption) (*Li // "type": "string" // }, // "limit": { - // "description": "Optional. The maximum number of records that should be returned.", + // "description": "Optional. The maximum number of the records that should be returned.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "parent": { - // "description": "The namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + // "description": "The namespace from which the configurations should be listed. For Cloud Run, replace {namespace_id} with the project ID or number.", // "location": "path", // "pattern": "^namespaces/[^/]+$", // "required": true, // "type": "string" // }, // "resourceVersion": { - // "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -5325,8 +5215,8 @@ func (c *NamespacesDomainmappingsDeleteCall) Kind(kind string) *NamespacesDomain // PropagationPolicy sets the optional parameter "propagationPolicy": // Specifies the propagation policy of delete. Cloud Run currently // ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ -// for more information. +// kubernetes.io/docs/concepts/architecture/garbage-collection/ for more +// information. func (c *NamespacesDomainmappingsDeleteCall) PropagationPolicy(propagationPolicy string) *NamespacesDomainmappingsDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) return c @@ -5449,7 +5339,7 @@ func (c *NamespacesDomainmappingsDeleteCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "propagationPolicy": { - // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", // "location": "query", // "type": "string" // } @@ -5625,7 +5515,7 @@ type NamespacesDomainmappingsListCall struct { header_ http.Header } -// List: List domain mappings. +// List: List all domain mappings. // // - parent: The namespace from which the domain mappings should be // listed. For Cloud Run (fully managed), replace {namespace} with the @@ -5790,7 +5680,7 @@ func (c *NamespacesDomainmappingsListCall) Do(opts ...googleapi.CallOption) (*Li } return ret, nil // { - // "description": "List domain mappings.", + // "description": "List all domain mappings.", // "flatPath": "apis/domains.cloudrun.com/v1/namespaces/{namespacesId}/domainmappings", // "httpMethod": "GET", // "id": "run.namespaces.domainmappings.list", @@ -6035,7 +5925,7 @@ func (c *NamespacesExecutionsDeleteCall) Kind(kind string) *NamespacesExecutions // PropagationPolicy sets the optional parameter "propagationPolicy": // Specifies the propagation policy of delete. Cloud Run currently // ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ +// http://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ // for more information. func (c *NamespacesExecutionsDeleteCall) PropagationPolicy(propagationPolicy string) *NamespacesExecutionsDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) @@ -6154,7 +6044,7 @@ func (c *NamespacesExecutionsDeleteCall) Do(opts ...googleapi.CallOption) (*Stat // "type": "string" // }, // "propagationPolicy": { - // "description": "Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see http://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", // "location": "query", // "type": "string" // } @@ -6347,17 +6237,15 @@ func (c *NamespacesExecutionsListCall) Continue(continue_ string) *NamespacesExe return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported by Cloud Run. func (c *NamespacesExecutionsListCall) FieldSelector(fieldSelector string) *NamespacesExecutionsListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported by Cloud Run. func (c *NamespacesExecutionsListCall) IncludeUninitialized(includeUninitialized bool) *NamespacesExecutionsListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -6371,24 +6259,22 @@ func (c *NamespacesExecutionsListCall) LabelSelector(labelSelector string) *Name return c } -// Limit sets the optional parameter "limit": The maximum number of +// Limit sets the optional parameter "limit": The maximum number of the // records that should be returned. func (c *NamespacesExecutionsListCall) Limit(limit int64) *NamespacesExecutionsListCall { c.urlParams_.Set("limit", fmt.Sprint(limit)) return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported by Cloud Run. func (c *NamespacesExecutionsListCall) ResourceVersion(resourceVersion string) *NamespacesExecutionsListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used -// by Cloud Run. +// Watch sets the optional parameter "watch": Not supported by Cloud +// Run. func (c *NamespacesExecutionsListCall) Watch(watch bool) *NamespacesExecutionsListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) return c @@ -6507,12 +6393,12 @@ func (c *NamespacesExecutionsListCall) Do(opts ...googleapi.CallOption) (*ListEx // "type": "string" // }, // "fieldSelector": { - // "description": "Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Optional. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -6522,7 +6408,7 @@ func (c *NamespacesExecutionsListCall) Do(opts ...googleapi.CallOption) (*ListEx // "type": "string" // }, // "limit": { - // "description": "Optional. The maximum number of records that should be returned.", + // "description": "Optional. The maximum number of the records that should be returned.", // "format": "int32", // "location": "query", // "type": "integer" @@ -6535,12 +6421,12 @@ func (c *NamespacesExecutionsListCall) Do(opts ...googleapi.CallOption) (*ListEx // "type": "string" // }, // "resourceVersion": { - // "description": "Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -7050,17 +6936,15 @@ func (c *NamespacesJobsListCall) Continue(continue_ string) *NamespacesJobsListC return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported by Cloud Run. func (c *NamespacesJobsListCall) FieldSelector(fieldSelector string) *NamespacesJobsListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported by Cloud Run. func (c *NamespacesJobsListCall) IncludeUninitialized(includeUninitialized bool) *NamespacesJobsListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -7081,17 +6965,15 @@ func (c *NamespacesJobsListCall) Limit(limit int64) *NamespacesJobsListCall { return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported by Cloud Run. func (c *NamespacesJobsListCall) ResourceVersion(resourceVersion string) *NamespacesJobsListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used -// by Cloud Run. +// Watch sets the optional parameter "watch": Not supported by Cloud +// Run. func (c *NamespacesJobsListCall) Watch(watch bool) *NamespacesJobsListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) return c @@ -7210,12 +7092,12 @@ func (c *NamespacesJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResp // "type": "string" // }, // "fieldSelector": { - // "description": "Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Optional. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -7238,12 +7120,12 @@ func (c *NamespacesJobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResp // "type": "string" // }, // "resourceVersion": { - // "description": "Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -7276,9 +7158,9 @@ type NamespacesJobsReplaceJobCall struct { // metadata.resourceVersion to enforce update from last read for // optimistic concurrency control. // -// - name: The name of the service being replaced. Replace {namespace} -// with the project ID or number. It takes the form -// namespaces/{namespace}. For example: namespaces/PROJECT_ID. +// - name: The name of the job being replaced. Replace {namespace} with +// the project ID or number. It takes the form namespaces/{namespace}. +// For example: namespaces/PROJECT_ID. func (r *NamespacesJobsService) ReplaceJob(name string, job *Job) *NamespacesJobsReplaceJobCall { c := &NamespacesJobsReplaceJobCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -7386,7 +7268,7 @@ func (c *NamespacesJobsReplaceJobCall) Do(opts ...googleapi.CallOption) (*Job, e // ], // "parameters": { // "name": { - // "description": "Required. The name of the service being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "Required. The name of the job being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", // "location": "path", // "pattern": "^namespaces/[^/]+/jobs/[^/]+$", // "required": true, @@ -7598,7 +7480,7 @@ func (c *NamespacesRevisionsDeleteCall) Kind(kind string) *NamespacesRevisionsDe // PropagationPolicy sets the optional parameter "propagationPolicy": // Specifies the propagation policy of delete. Cloud Run currently // ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ +// https://kubernetes.io/docs/concepts/architecture/garbage-collection/ // for more information. func (c *NamespacesRevisionsDeleteCall) PropagationPolicy(propagationPolicy string) *NamespacesRevisionsDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) @@ -7722,7 +7604,7 @@ func (c *NamespacesRevisionsDeleteCall) Do(opts ...googleapi.CallOption) (*Statu // "type": "string" // }, // "propagationPolicy": { - // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see https://kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", // "location": "query", // "type": "string" // } @@ -8525,12 +8407,14 @@ type NamespacesServicesCreateCall struct { header_ http.Header } -// Create: Create a service. +// Create: Creates a new Service. Service creation will trigger a new +// deployment. Use GetService, and check service.status to determine if +// the Service is ready. // -// - parent: The namespace in which the service should be created. For -// Cloud Run (fully managed), replace {namespace} with the project ID -// or number. It takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - parent: The resource's parent. In Cloud Run, it may be one of the +// following: * `namespaces/{project_id_or_number}` * +// `projects/{project_id_or_number}/locations/{region}` * +// `projects/{project_id_or_number}/regions/{region}`. func (r *NamespacesServicesService) Create(parent string, service *Service) *NamespacesServicesCreateCall { c := &NamespacesServicesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -8637,7 +8521,7 @@ func (c *NamespacesServicesCreateCall) Do(opts ...googleapi.CallOption) (*Servic } return ret, nil // { - // "description": "Create a service.", + // "description": "Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.", // "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services", // "httpMethod": "POST", // "id": "run.namespaces.services.create", @@ -8651,7 +8535,7 @@ func (c *NamespacesServicesCreateCall) Do(opts ...googleapi.CallOption) (*Servic // "type": "string" // }, // "parent": { - // "description": "The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The resource's parent. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", // "location": "path", // "pattern": "^namespaces/[^/]+$", // "required": true, @@ -8682,22 +8566,24 @@ type NamespacesServicesDeleteCall struct { header_ http.Header } -// Delete: Delete a service. This will cause the Service to stop serving -// traffic and will delete the child entities like Routes, -// Configurations and Revisions. +// Delete: Deletes the provided service. This will cause the Service to +// stop serving traffic and will delete all associated Revisions. // -// - name: The name of the service to delete. For Cloud Run (fully -// managed), replace {namespace} with the project ID or number. It -// takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - name: The fully qualified name of the service to delete. It can be +// any of the following forms: * +// `namespaces/{project_id_or_number}/services/{service_name}` * +// `projects/{project_id_or_number}/locations/{region}/services/{servic +// e_name}` * +// `projects/{project_id_or_number}/regions/{region}/services/{service_ +// name}`. func (r *NamespacesServicesService) Delete(name string) *NamespacesServicesDeleteCall { c := &NamespacesServicesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name return c } -// ApiVersion sets the optional parameter "apiVersion": Cloud Run -// currently ignores this parameter. +// ApiVersion sets the optional parameter "apiVersion": Not supported, +// and ignored by Cloud Run. func (c *NamespacesServicesDeleteCall) ApiVersion(apiVersion string) *NamespacesServicesDeleteCall { c.urlParams_.Set("apiVersion", apiVersion) return c @@ -8711,18 +8597,15 @@ func (c *NamespacesServicesDeleteCall) DryRun(dryRun string) *NamespacesServices return c } -// Kind sets the optional parameter "kind": Cloud Run currently ignores -// this parameter. +// Kind sets the optional parameter "kind": Not supported, and ignored +// by Cloud Run. func (c *NamespacesServicesDeleteCall) Kind(kind string) *NamespacesServicesDeleteCall { c.urlParams_.Set("kind", kind) return c } // PropagationPolicy sets the optional parameter "propagationPolicy": -// Specifies the propagation policy of delete. Cloud Run currently -// ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ -// for more information. +// Not supported, and ignored by Cloud Run. func (c *NamespacesServicesDeleteCall) PropagationPolicy(propagationPolicy string) *NamespacesServicesDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) return c @@ -8814,7 +8697,7 @@ func (c *NamespacesServicesDeleteCall) Do(opts ...googleapi.CallOption) (*Status } return ret, nil // { - // "description": "Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.", + // "description": "Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.", // "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services/{servicesId}", // "httpMethod": "DELETE", // "id": "run.namespaces.services.delete", @@ -8823,7 +8706,7 @@ func (c *NamespacesServicesDeleteCall) Do(opts ...googleapi.CallOption) (*Status // ], // "parameters": { // "apiVersion": { - // "description": "Cloud Run currently ignores this parameter.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, @@ -8833,19 +8716,19 @@ func (c *NamespacesServicesDeleteCall) Do(opts ...googleapi.CallOption) (*Status // "type": "string" // }, // "kind": { - // "description": "Cloud Run currently ignores this parameter.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, // "name": { - // "description": "The name of the service to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The fully qualified name of the service to delete. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", // "location": "path", // "pattern": "^namespaces/[^/]+/services/[^/]+$", // "required": true, // "type": "string" // }, // "propagationPolicy": { - // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // } @@ -8872,12 +8755,15 @@ type NamespacesServicesGetCall struct { header_ http.Header } -// Get: Get information about a service. +// Get: Gets information about a service. // -// - name: The name of the service to retrieve. For Cloud Run (fully -// managed), replace {namespace} with the project ID or number. It -// takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - name: The fully qualified name of the service to retrieve. It can +// be any of the following forms: * +// `namespaces/{project_id_or_number}/services/{service_name}` * +// `projects/{project_id_or_number}/locations/{region}/services/{servic +// e_name}` * +// `projects/{project_id_or_number}/regions/{region}/services/{service_ +// name}`. func (r *NamespacesServicesService) Get(name string) *NamespacesServicesGetCall { c := &NamespacesServicesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -8983,7 +8869,7 @@ func (c *NamespacesServicesGetCall) Do(opts ...googleapi.CallOption) (*Service, } return ret, nil // { - // "description": "Get information about a service.", + // "description": "Gets information about a service.", // "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services/{servicesId}", // "httpMethod": "GET", // "id": "run.namespaces.services.get", @@ -8992,7 +8878,7 @@ func (c *NamespacesServicesGetCall) Do(opts ...googleapi.CallOption) (*Service, // ], // "parameters": { // "name": { - // "description": "The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The fully qualified name of the service to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", // "location": "path", // "pattern": "^namespaces/[^/]+/services/[^/]+$", // "required": true, @@ -9021,12 +8907,13 @@ type NamespacesServicesListCall struct { header_ http.Header } -// List: List services. +// List: Lists services for the given project and region. // -// - parent: The namespace from which the services should be listed. For -// Cloud Run (fully managed), replace {namespace} with the project ID -// or number. It takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - parent: The parent from where the resources should be listed. In +// Cloud Run, it may be one of the following: * +// `namespaces/{project_id_or_number}` * +// `projects/{project_id_or_number}/locations/{region}` * +// `projects/{project_id_or_number}/regions/{region}`. func (r *NamespacesServicesService) List(parent string) *NamespacesServicesListCall { c := &NamespacesServicesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -9040,17 +8927,15 @@ func (c *NamespacesServicesListCall) Continue(continue_ string) *NamespacesServi return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported, and ignored by Cloud Run. func (c *NamespacesServicesListCall) FieldSelector(fieldSelector string) *NamespacesServicesListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported, and ignored by Cloud Run. func (c *NamespacesServicesListCall) IncludeUninitialized(includeUninitialized bool) *NamespacesServicesListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -9071,16 +8956,14 @@ func (c *NamespacesServicesListCall) Limit(limit int64) *NamespacesServicesListC return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported, and ignored by Cloud Run. func (c *NamespacesServicesListCall) ResourceVersion(resourceVersion string) *NamespacesServicesListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used +// Watch sets the optional parameter "watch": Not supported, and ignored // by Cloud Run. func (c *NamespacesServicesListCall) Watch(watch bool) *NamespacesServicesListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) @@ -9186,7 +9069,7 @@ func (c *NamespacesServicesListCall) Do(opts ...googleapi.CallOption) (*ListServ } return ret, nil // { - // "description": "List services.", + // "description": "Lists services for the given project and region.", // "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services", // "httpMethod": "GET", // "id": "run.namespaces.services.list", @@ -9200,12 +9083,12 @@ func (c *NamespacesServicesListCall) Do(opts ...googleapi.CallOption) (*ListServ // "type": "string" // }, // "fieldSelector": { - // "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -9221,19 +9104,19 @@ func (c *NamespacesServicesListCall) Do(opts ...googleapi.CallOption) (*ListServ // "type": "integer" // }, // "parent": { - // "description": "The namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", // "location": "path", // "pattern": "^namespaces/[^/]+$", // "required": true, // "type": "string" // }, // "resourceVersion": { - // "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -9260,16 +9143,19 @@ type NamespacesServicesReplaceServiceCall struct { header_ http.Header } -// ReplaceService: Replace a service. Only the spec and metadata labels +// ReplaceService: Replaces a service. Only the spec and metadata labels // and annotations are modifiable. After the Update request, Cloud Run // will work to make the 'status' match the requested 'spec'. May // provide metadata.resourceVersion to enforce update from last read for // optimistic concurrency control. // -// - name: The name of the service being replaced. For Cloud Run (fully -// managed), replace {namespace} with the project ID or number. It -// takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - name: The fully qualified name of the service to replace. It can be +// any of the following forms: * +// `namespaces/{project_id_or_number}/services/{service_name}` * +// `projects/{project_id_or_number}/locations/{region}/services/{servic +// e_name}` * +// `projects/{project_id_or_number}/regions/{region}/services/{service_ +// name}`. func (r *NamespacesServicesService) ReplaceService(name string, service *Service) *NamespacesServicesReplaceServiceCall { c := &NamespacesServicesReplaceServiceCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -9376,7 +9262,7 @@ func (c *NamespacesServicesReplaceServiceCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", + // "description": "Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", // "flatPath": "apis/serving.knative.dev/v1/namespaces/{namespacesId}/services/{servicesId}", // "httpMethod": "PUT", // "id": "run.namespaces.services.replaceService", @@ -9390,7 +9276,7 @@ func (c *NamespacesServicesReplaceServiceCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "name": { - // "description": "The name of the service being replaced. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The fully qualified name of the service to replace. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", // "location": "path", // "pattern": "^namespaces/[^/]+/services/[^/]+$", // "required": true, @@ -9588,17 +9474,15 @@ func (c *NamespacesTasksListCall) Continue(continue_ string) *NamespacesTasksLis return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported by Cloud Run. func (c *NamespacesTasksListCall) FieldSelector(fieldSelector string) *NamespacesTasksListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported by Cloud Run. func (c *NamespacesTasksListCall) IncludeUninitialized(includeUninitialized bool) *NamespacesTasksListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -9619,17 +9503,15 @@ func (c *NamespacesTasksListCall) Limit(limit int64) *NamespacesTasksListCall { return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported by Cloud Run. func (c *NamespacesTasksListCall) ResourceVersion(resourceVersion string) *NamespacesTasksListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used -// by Cloud Run. +// Watch sets the optional parameter "watch": Not supported by Cloud +// Run. func (c *NamespacesTasksListCall) Watch(watch bool) *NamespacesTasksListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) return c @@ -9748,12 +9630,12 @@ func (c *NamespacesTasksListCall) Do(opts ...googleapi.CallOption) (*ListTasksRe // "type": "string" // }, // "fieldSelector": { - // "description": "Optional. Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Optional. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -9776,12 +9658,12 @@ func (c *NamespacesTasksListCall) Do(opts ...googleapi.CallOption) (*ListTasksRe // "type": "string" // }, // "resourceVersion": { - // "description": "Optional. The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Optional. Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Optional. Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -10405,9 +10287,8 @@ type ProjectsLocationsConfigurationsGetCall struct { // Get: Get information about a configuration. // -// - name: The name of the configuration to retrieve. For Cloud Run -// (fully managed), replace {namespace_id} with the project ID or -// number. +// - name: The name of the configuration to retrieve. For Cloud Run, +// replace {namespace_id} with the project ID or number. func (r *ProjectsLocationsConfigurationsService) Get(name string) *ProjectsLocationsConfigurationsGetCall { c := &ProjectsLocationsConfigurationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -10522,7 +10403,7 @@ func (c *ProjectsLocationsConfigurationsGetCall) Do(opts ...googleapi.CallOption // ], // "parameters": { // "name": { - // "description": "The name of the configuration to retrieve. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + // "description": "The name of the configuration to retrieve. For Cloud Run, replace {namespace_id} with the project ID or number.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/configurations/[^/]+$", // "required": true, @@ -10554,8 +10435,8 @@ type ProjectsLocationsConfigurationsListCall struct { // List: List configurations. // // - parent: The namespace from which the configurations should be -// listed. For Cloud Run (fully managed), replace {namespace_id} with -// the project ID or number. +// listed. For Cloud Run, replace {namespace_id} with the project ID +// or number. func (r *ProjectsLocationsConfigurationsService) List(parent string) *ProjectsLocationsConfigurationsListCall { c := &ProjectsLocationsConfigurationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -10569,17 +10450,15 @@ func (c *ProjectsLocationsConfigurationsListCall) Continue(continue_ string) *Pr return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported by Cloud Run. func (c *ProjectsLocationsConfigurationsListCall) FieldSelector(fieldSelector string) *ProjectsLocationsConfigurationsListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported by Cloud Run. func (c *ProjectsLocationsConfigurationsListCall) IncludeUninitialized(includeUninitialized bool) *ProjectsLocationsConfigurationsListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -10593,24 +10472,22 @@ func (c *ProjectsLocationsConfigurationsListCall) LabelSelector(labelSelector st return c } -// Limit sets the optional parameter "limit": The maximum number of +// Limit sets the optional parameter "limit": The maximum number of the // records that should be returned. func (c *ProjectsLocationsConfigurationsListCall) Limit(limit int64) *ProjectsLocationsConfigurationsListCall { c.urlParams_.Set("limit", fmt.Sprint(limit)) return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported by Cloud Run. func (c *ProjectsLocationsConfigurationsListCall) ResourceVersion(resourceVersion string) *ProjectsLocationsConfigurationsListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used -// by Cloud Run. +// Watch sets the optional parameter "watch": Not supported by Cloud +// Run. func (c *ProjectsLocationsConfigurationsListCall) Watch(watch bool) *ProjectsLocationsConfigurationsListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) return c @@ -10729,12 +10606,12 @@ func (c *ProjectsLocationsConfigurationsListCall) Do(opts ...googleapi.CallOptio // "type": "string" // }, // "fieldSelector": { - // "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -10744,25 +10621,25 @@ func (c *ProjectsLocationsConfigurationsListCall) Do(opts ...googleapi.CallOptio // "type": "string" // }, // "limit": { - // "description": "Optional. The maximum number of records that should be returned.", + // "description": "Optional. The maximum number of the records that should be returned.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "parent": { - // "description": "The namespace from which the configurations should be listed. For Cloud Run (fully managed), replace {namespace_id} with the project ID or number.", + // "description": "The namespace from which the configurations should be listed. For Cloud Run, replace {namespace_id} with the project ID or number.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+$", // "required": true, // "type": "string" // }, // "resourceVersion": { - // "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Not supported by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -10983,8 +10860,8 @@ func (c *ProjectsLocationsDomainmappingsDeleteCall) Kind(kind string) *ProjectsL // PropagationPolicy sets the optional parameter "propagationPolicy": // Specifies the propagation policy of delete. Cloud Run currently // ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ -// for more information. +// kubernetes.io/docs/concepts/architecture/garbage-collection/ for more +// information. func (c *ProjectsLocationsDomainmappingsDeleteCall) PropagationPolicy(propagationPolicy string) *ProjectsLocationsDomainmappingsDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) return c @@ -11107,7 +10984,7 @@ func (c *ProjectsLocationsDomainmappingsDeleteCall) Do(opts ...googleapi.CallOpt // "type": "string" // }, // "propagationPolicy": { - // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", // "location": "query", // "type": "string" // } @@ -11283,7 +11160,7 @@ type ProjectsLocationsDomainmappingsListCall struct { header_ http.Header } -// List: List domain mappings. +// List: List all domain mappings. // // - parent: The namespace from which the domain mappings should be // listed. For Cloud Run (fully managed), replace {namespace} with the @@ -11448,7 +11325,7 @@ func (c *ProjectsLocationsDomainmappingsListCall) Do(opts ...googleapi.CallOptio } return ret, nil // { - // "description": "List domain mappings.", + // "description": "List all domain mappings.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/domainmappings", // "httpMethod": "GET", // "id": "run.projects.locations.domainmappings.list", @@ -12026,7 +11903,7 @@ func (c *ProjectsLocationsRevisionsDeleteCall) Kind(kind string) *ProjectsLocati // PropagationPolicy sets the optional parameter "propagationPolicy": // Specifies the propagation policy of delete. Cloud Run currently // ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ +// https://kubernetes.io/docs/concepts/architecture/garbage-collection/ // for more information. func (c *ProjectsLocationsRevisionsDeleteCall) PropagationPolicy(propagationPolicy string) *ProjectsLocationsRevisionsDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) @@ -12150,7 +12027,7 @@ func (c *ProjectsLocationsRevisionsDeleteCall) Do(opts ...googleapi.CallOption) // "type": "string" // }, // "propagationPolicy": { - // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see https://kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information.", // "location": "query", // "type": "string" // } @@ -12953,12 +12830,14 @@ type ProjectsLocationsServicesCreateCall struct { header_ http.Header } -// Create: Create a service. +// Create: Creates a new Service. Service creation will trigger a new +// deployment. Use GetService, and check service.status to determine if +// the Service is ready. // -// - parent: The namespace in which the service should be created. For -// Cloud Run (fully managed), replace {namespace} with the project ID -// or number. It takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - parent: The resource's parent. In Cloud Run, it may be one of the +// following: * `namespaces/{project_id_or_number}` * +// `projects/{project_id_or_number}/locations/{region}` * +// `projects/{project_id_or_number}/regions/{region}`. func (r *ProjectsLocationsServicesService) Create(parent string, service *Service) *ProjectsLocationsServicesCreateCall { c := &ProjectsLocationsServicesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -13065,7 +12944,7 @@ func (c *ProjectsLocationsServicesCreateCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Create a service.", + // "description": "Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", // "httpMethod": "POST", // "id": "run.projects.locations.services.create", @@ -13079,7 +12958,7 @@ func (c *ProjectsLocationsServicesCreateCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "parent": { - // "description": "The namespace in which the service should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The resource's parent. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+$", // "required": true, @@ -13110,22 +12989,24 @@ type ProjectsLocationsServicesDeleteCall struct { header_ http.Header } -// Delete: Delete a service. This will cause the Service to stop serving -// traffic and will delete the child entities like Routes, -// Configurations and Revisions. +// Delete: Deletes the provided service. This will cause the Service to +// stop serving traffic and will delete all associated Revisions. // -// - name: The name of the service to delete. For Cloud Run (fully -// managed), replace {namespace} with the project ID or number. It -// takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - name: The fully qualified name of the service to delete. It can be +// any of the following forms: * +// `namespaces/{project_id_or_number}/services/{service_name}` * +// `projects/{project_id_or_number}/locations/{region}/services/{servic +// e_name}` * +// `projects/{project_id_or_number}/regions/{region}/services/{service_ +// name}`. func (r *ProjectsLocationsServicesService) Delete(name string) *ProjectsLocationsServicesDeleteCall { c := &ProjectsLocationsServicesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name return c } -// ApiVersion sets the optional parameter "apiVersion": Cloud Run -// currently ignores this parameter. +// ApiVersion sets the optional parameter "apiVersion": Not supported, +// and ignored by Cloud Run. func (c *ProjectsLocationsServicesDeleteCall) ApiVersion(apiVersion string) *ProjectsLocationsServicesDeleteCall { c.urlParams_.Set("apiVersion", apiVersion) return c @@ -13139,18 +13020,15 @@ func (c *ProjectsLocationsServicesDeleteCall) DryRun(dryRun string) *ProjectsLoc return c } -// Kind sets the optional parameter "kind": Cloud Run currently ignores -// this parameter. +// Kind sets the optional parameter "kind": Not supported, and ignored +// by Cloud Run. func (c *ProjectsLocationsServicesDeleteCall) Kind(kind string) *ProjectsLocationsServicesDeleteCall { c.urlParams_.Set("kind", kind) return c } // PropagationPolicy sets the optional parameter "propagationPolicy": -// Specifies the propagation policy of delete. Cloud Run currently -// ignores this setting, and deletes in the background. Please see -// kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ -// for more information. +// Not supported, and ignored by Cloud Run. func (c *ProjectsLocationsServicesDeleteCall) PropagationPolicy(propagationPolicy string) *ProjectsLocationsServicesDeleteCall { c.urlParams_.Set("propagationPolicy", propagationPolicy) return c @@ -13242,7 +13120,7 @@ func (c *ProjectsLocationsServicesDeleteCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.", + // "description": "Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", // "httpMethod": "DELETE", // "id": "run.projects.locations.services.delete", @@ -13251,7 +13129,7 @@ func (c *ProjectsLocationsServicesDeleteCall) Do(opts ...googleapi.CallOption) ( // ], // "parameters": { // "apiVersion": { - // "description": "Cloud Run currently ignores this parameter.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, @@ -13261,19 +13139,19 @@ func (c *ProjectsLocationsServicesDeleteCall) Do(opts ...googleapi.CallOption) ( // "type": "string" // }, // "kind": { - // "description": "Cloud Run currently ignores this parameter.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, // "name": { - // "description": "The name of the service to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The fully qualified name of the service to delete. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", // "required": true, // "type": "string" // }, // "propagationPolicy": { - // "description": "Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // } @@ -13300,12 +13178,15 @@ type ProjectsLocationsServicesGetCall struct { header_ http.Header } -// Get: Get information about a service. +// Get: Gets information about a service. // -// - name: The name of the service to retrieve. For Cloud Run (fully -// managed), replace {namespace} with the project ID or number. It -// takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - name: The fully qualified name of the service to retrieve. It can +// be any of the following forms: * +// `namespaces/{project_id_or_number}/services/{service_name}` * +// `projects/{project_id_or_number}/locations/{region}/services/{servic +// e_name}` * +// `projects/{project_id_or_number}/regions/{region}/services/{service_ +// name}`. func (r *ProjectsLocationsServicesService) Get(name string) *ProjectsLocationsServicesGetCall { c := &ProjectsLocationsServicesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -13411,7 +13292,7 @@ func (c *ProjectsLocationsServicesGetCall) Do(opts ...googleapi.CallOption) (*Se } return ret, nil // { - // "description": "Get information about a service.", + // "description": "Gets information about a service.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", // "httpMethod": "GET", // "id": "run.projects.locations.services.get", @@ -13420,7 +13301,7 @@ func (c *ProjectsLocationsServicesGetCall) Do(opts ...googleapi.CallOption) (*Se // ], // "parameters": { // "name": { - // "description": "The name of the service to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The fully qualified name of the service to retrieve. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", // "required": true, @@ -13449,7 +13330,7 @@ type ProjectsLocationsServicesGetIamPolicyCall struct { header_ http.Header } -// GetIamPolicy: Get the IAM Access Control policy currently in effect +// GetIamPolicy: Gets the IAM Access Control policy currently in effect // for the given Cloud Run service. This result does not include any // inherited policies. // @@ -13580,7 +13461,7 @@ func (c *ProjectsLocationsServicesGetIamPolicyCall) Do(opts ...googleapi.CallOpt } return ret, nil // { - // "description": "Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.", + // "description": "Gets the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy", // "httpMethod": "GET", // "id": "run.projects.locations.services.getIamPolicy", @@ -13624,12 +13505,13 @@ type ProjectsLocationsServicesListCall struct { header_ http.Header } -// List: List services. +// List: Lists services for the given project and region. // -// - parent: The namespace from which the services should be listed. For -// Cloud Run (fully managed), replace {namespace} with the project ID -// or number. It takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - parent: The parent from where the resources should be listed. In +// Cloud Run, it may be one of the following: * +// `namespaces/{project_id_or_number}` * +// `projects/{project_id_or_number}/locations/{region}` * +// `projects/{project_id_or_number}/regions/{region}`. func (r *ProjectsLocationsServicesService) List(parent string) *ProjectsLocationsServicesListCall { c := &ProjectsLocationsServicesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -13643,17 +13525,15 @@ func (c *ProjectsLocationsServicesListCall) Continue(continue_ string) *Projects return c } -// FieldSelector sets the optional parameter "fieldSelector": Allows to -// filter resources based on a specific value for a field name. Send -// this in a query string format. i.e. 'metadata.name%3Dlorem'. Not -// currently used by Cloud Run. +// FieldSelector sets the optional parameter "fieldSelector": Not +// supported, and ignored by Cloud Run. func (c *ProjectsLocationsServicesListCall) FieldSelector(fieldSelector string) *ProjectsLocationsServicesListCall { c.urlParams_.Set("fieldSelector", fieldSelector) return c } // IncludeUninitialized sets the optional parameter -// "includeUninitialized": Not currently used by Cloud Run. +// "includeUninitialized": Not supported, and ignored by Cloud Run. func (c *ProjectsLocationsServicesListCall) IncludeUninitialized(includeUninitialized bool) *ProjectsLocationsServicesListCall { c.urlParams_.Set("includeUninitialized", fmt.Sprint(includeUninitialized)) return c @@ -13674,16 +13554,14 @@ func (c *ProjectsLocationsServicesListCall) Limit(limit int64) *ProjectsLocation return c } -// ResourceVersion sets the optional parameter "resourceVersion": The -// baseline resource version from which the list or watch operation -// should start. Not currently used by Cloud Run. +// ResourceVersion sets the optional parameter "resourceVersion": Not +// supported, and ignored by Cloud Run. func (c *ProjectsLocationsServicesListCall) ResourceVersion(resourceVersion string) *ProjectsLocationsServicesListCall { c.urlParams_.Set("resourceVersion", resourceVersion) return c } -// Watch sets the optional parameter "watch": Flag that indicates that -// the client expects to watch this resource as well. Not currently used +// Watch sets the optional parameter "watch": Not supported, and ignored // by Cloud Run. func (c *ProjectsLocationsServicesListCall) Watch(watch bool) *ProjectsLocationsServicesListCall { c.urlParams_.Set("watch", fmt.Sprint(watch)) @@ -13789,7 +13667,7 @@ func (c *ProjectsLocationsServicesListCall) Do(opts ...googleapi.CallOption) (*L } return ret, nil // { - // "description": "List services.", + // "description": "Lists services for the given project and region.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", // "httpMethod": "GET", // "id": "run.projects.locations.services.list", @@ -13803,12 +13681,12 @@ func (c *ProjectsLocationsServicesListCall) Do(opts ...googleapi.CallOption) (*L // "type": "string" // }, // "fieldSelector": { - // "description": "Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, // "includeUninitialized": { - // "description": "Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "boolean" // }, @@ -13824,19 +13702,19 @@ func (c *ProjectsLocationsServicesListCall) Do(opts ...googleapi.CallOption) (*L // "type": "integer" // }, // "parent": { - // "description": "The namespace from which the services should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The parent from where the resources should be listed. In Cloud Run, it may be one of the following: * `namespaces/{project_id_or_number}` * `projects/{project_id_or_number}/locations/{region}` * `projects/{project_id_or_number}/regions/{region}`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+$", // "required": true, // "type": "string" // }, // "resourceVersion": { - // "description": "The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "string" // }, // "watch": { - // "description": "Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.", + // "description": "Not supported, and ignored by Cloud Run.", // "location": "query", // "type": "boolean" // } @@ -13863,16 +13741,19 @@ type ProjectsLocationsServicesReplaceServiceCall struct { header_ http.Header } -// ReplaceService: Replace a service. Only the spec and metadata labels +// ReplaceService: Replaces a service. Only the spec and metadata labels // and annotations are modifiable. After the Update request, Cloud Run // will work to make the 'status' match the requested 'spec'. May // provide metadata.resourceVersion to enforce update from last read for // optimistic concurrency control. // -// - name: The name of the service being replaced. For Cloud Run (fully -// managed), replace {namespace} with the project ID or number. It -// takes the form namespaces/{namespace}. For example: -// namespaces/PROJECT_ID. +// - name: The fully qualified name of the service to replace. It can be +// any of the following forms: * +// `namespaces/{project_id_or_number}/services/{service_name}` * +// `projects/{project_id_or_number}/locations/{region}/services/{servic +// e_name}` * +// `projects/{project_id_or_number}/regions/{region}/services/{service_ +// name}`. func (r *ProjectsLocationsServicesService) ReplaceService(name string, service *Service) *ProjectsLocationsServicesReplaceServiceCall { c := &ProjectsLocationsServicesReplaceServiceCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -13979,7 +13860,7 @@ func (c *ProjectsLocationsServicesReplaceServiceCall) Do(opts ...googleapi.CallO } return ret, nil // { - // "description": "Replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", + // "description": "Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", // "httpMethod": "PUT", // "id": "run.projects.locations.services.replaceService", @@ -13993,7 +13874,7 @@ func (c *ProjectsLocationsServicesReplaceServiceCall) Do(opts ...googleapi.CallO // "type": "string" // }, // "name": { - // "description": "The name of the service being replaced. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", + // "description": "The fully qualified name of the service to replace. It can be any of the following forms: * `namespaces/{project_id_or_number}/services/{service_name}` * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` * `projects/{project_id_or_number}/regions/{region}/services/{service_name}`", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", // "required": true, diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json index 1f99214d7f2..80ce11f5311 100644 --- a/searchconsole/v1/searchconsole-api.json +++ b/searchconsole/v1/searchconsole-api.json @@ -400,7 +400,7 @@ } } }, - "revision": "20220303", + "revision": "20220816", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { @@ -419,7 +419,7 @@ "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", - "Equivalent to \"Valid with warnings\" for the page or item in Search Console.", + "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], @@ -515,7 +515,7 @@ "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", - "Equivalent to \"Valid with warnings\" for the page or item in Search Console.", + "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], @@ -815,7 +815,7 @@ "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", - "Equivalent to \"Valid with warnings\" for the page or item in Search Console.", + "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], @@ -924,7 +924,7 @@ "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", - "Equivalent to \"Valid with warnings\" for the page or item in Search Console.", + "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], @@ -1014,7 +1014,7 @@ "enumDescriptions": [ "Unknown verdict.", "Equivalent to \"Valid\" for the page or item in Search Console.", - "Equivalent to \"Valid with warnings\" for the page or item in Search Console.", + "Reserved, no longer in use.", "Equivalent to \"Error\" or \"Invalid\" for the page or item in Search Console.", "Equivalent to \"Excluded\" for the page or item in Search Console." ], diff --git a/searchconsole/v1/searchconsole-gen.go b/searchconsole/v1/searchconsole-gen.go index 6996d743ba1..f9036a22e45 100644 --- a/searchconsole/v1/searchconsole-gen.go +++ b/searchconsole/v1/searchconsole-gen.go @@ -235,8 +235,7 @@ type AmpInspectionResult struct { // "VERDICT_UNSPECIFIED" - Unknown verdict. // "PASS" - Equivalent to "Valid" for the page or item in Search // Console. - // "PARTIAL" - Equivalent to "Valid with warnings" for the page or - // item in Search Console. + // "PARTIAL" - Reserved, no longer in use. // "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in // Search Console. // "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search @@ -304,8 +303,7 @@ type AmpInspectionResult struct { // "VERDICT_UNSPECIFIED" - Unknown verdict. // "PASS" - Equivalent to "Valid" for the page or item in Search // Console. - // "PARTIAL" - Equivalent to "Valid with warnings" for the page or - // item in Search Console. + // "PARTIAL" - Reserved, no longer in use. // "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in // Search Console. // "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search @@ -698,8 +696,7 @@ type IndexStatusInspectionResult struct { // "VERDICT_UNSPECIFIED" - Unknown verdict. // "PASS" - Equivalent to "Valid" for the page or item in Search // Console. - // "PARTIAL" - Equivalent to "Valid with warnings" for the page or - // item in Search Console. + // "PARTIAL" - Reserved, no longer in use. // "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in // Search Console. // "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search @@ -896,8 +893,7 @@ type MobileUsabilityInspectionResult struct { // "VERDICT_UNSPECIFIED" - Unknown verdict. // "PASS" - Equivalent to "Valid" for the page or item in Search // Console. - // "PARTIAL" - Equivalent to "Valid with warnings" for the page or - // item in Search Console. + // "PARTIAL" - Reserved, no longer in use. // "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in // Search Console. // "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search @@ -1031,8 +1027,7 @@ type RichResultsInspectionResult struct { // "VERDICT_UNSPECIFIED" - Unknown verdict. // "PASS" - Equivalent to "Valid" for the page or item in Search // Console. - // "PARTIAL" - Equivalent to "Valid with warnings" for the page or - // item in Search Console. + // "PARTIAL" - Reserved, no longer in use. // "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in // Search Console. // "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search diff --git a/secretmanager/v1/secretmanager-api.json b/secretmanager/v1/secretmanager-api.json index 589ed9aada1..ce498b2e0dd 100644 --- a/secretmanager/v1/secretmanager-api.json +++ b/secretmanager/v1/secretmanager-api.json @@ -643,7 +643,7 @@ } } }, - "revision": "20220617", + "revision": "20220812", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -752,7 +752,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" }, @@ -1061,6 +1061,13 @@ "description": "A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.", "id": "Secret", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB.", + "type": "object" + }, "createTime": { "description": "Output only. The time at which the Secret was created.", "format": "google-datetime", diff --git a/secretmanager/v1/secretmanager-gen.go b/secretmanager/v1/secretmanager-gen.go index aa76c6bda31..3f19842ae7b 100644 --- a/secretmanager/v1/secretmanager-gen.go +++ b/secretmanager/v1/secretmanager-gen.go @@ -435,16 +435,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, @@ -1194,6 +1198,17 @@ func (s *Rotation) MarshalJSON() ([]byte, error) { // accessed. A Secret is made up of zero or more SecretVersions that // represent the secret data. type Secret struct { + // Annotations: Optional. Custom metadata about the secret. Annotations + // are distinct from various forms of labels. Annotations exist to allow + // client tools to store their own state information without requiring a + // database. Annotation keys must be between 1 and 63 characters long, + // have a UTF-8 encoding of maximum 128 bytes, begin and end with an + // alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), + // underscores (_), dots (.), and alphanumerics in between these + // symbols. The total size of annotation keys and values must be less + // than 16KiB. + Annotations map[string]string `json:"annotations,omitempty"` + // CreateTime: Output only. The time at which the Secret was created. CreateTime string `json:"createTime,omitempty"` @@ -1250,7 +1265,7 @@ type Secret struct { // server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "CreateTime") to + // ForceSendFields is a list of field names (e.g. "Annotations") 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 @@ -1258,10 +1273,10 @@ type Secret struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CreateTime") 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 + // NullFields is a list of field names (e.g. "Annotations") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` diff --git a/secretmanager/v1beta1/secretmanager-api.json b/secretmanager/v1beta1/secretmanager-api.json index 1cdc6f863a7..d06abeee304 100644 --- a/secretmanager/v1beta1/secretmanager-api.json +++ b/secretmanager/v1beta1/secretmanager-api.json @@ -628,7 +628,7 @@ } } }, - "revision": "20220506", + "revision": "20220812", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -720,7 +720,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/secretmanager/v1beta1/secretmanager-gen.go b/secretmanager/v1beta1/secretmanager-gen.go index 64a3c6cbcb0..e3ead2f6b60 100644 --- a/secretmanager/v1beta1/secretmanager-gen.go +++ b/secretmanager/v1beta1/secretmanager-gen.go @@ -370,16 +370,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/serviceconsumermanagement/v1/serviceconsumermanagement-api.json b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json index 431d39fb6ff..6e1377ed476 100644 --- a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json +++ b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json @@ -542,7 +542,7 @@ } } }, - "revision": "20220615", + "revision": "20220816", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1789,6 +1789,10 @@ "description": "OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for \"Read-only access to Google Calendar\" and \"Access to Cloud Platform\". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.", "id": "OAuthRequirements", "properties": { + "allowAnyScope": { + "description": "UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api-auth@ and esf-team@ for approval and allowlisting before you enable this option. ", + "type": "boolean" + }, "canonicalScopes": { "description": "The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read", "type": "string" diff --git a/serviceconsumermanagement/v1/serviceconsumermanagement-gen.go b/serviceconsumermanagement/v1/serviceconsumermanagement-gen.go index 9d259150582..0ee228f90e8 100644 --- a/serviceconsumermanagement/v1/serviceconsumermanagement-gen.go +++ b/serviceconsumermanagement/v1/serviceconsumermanagement-gen.go @@ -2699,6 +2699,15 @@ func (s *MonitoringDestination) MarshalJSON() ([]byte, error) { // accepted and passed to the backend, a request can still fail due to // the backend requiring additional scopes or permissions. type OAuthRequirements struct { + // AllowAnyScope: UNIMPLEMENTED: If enabled, ESF will allow OAuth + // credentials with any scope, more details in + // http://go/esf-oauth-any-scope. WARNING: Enabling this option will + // bring security risks. Customers enabling this feature accidentally + // may have the risk of losing authentication enforcement. Please reach + // out to api-auth@ and esf-team@ for approval and allowlisting before + // you enable this option. + AllowAnyScope bool `json:"allowAnyScope,omitempty"` + // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An OAuth token containing any of these scopes // will be accepted. Example: canonical_scopes: @@ -2706,7 +2715,7 @@ type OAuthRequirements struct { // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` - // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to + // ForceSendFields is a list of field names (e.g. "AllowAnyScope") 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 @@ -2714,13 +2723,12 @@ type OAuthRequirements struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CanonicalScopes") 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. "AllowAnyScope") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } diff --git a/serviceconsumermanagement/v1beta1/serviceconsumermanagement-api.json b/serviceconsumermanagement/v1beta1/serviceconsumermanagement-api.json index 6e268e54531..3361d98a9a4 100644 --- a/serviceconsumermanagement/v1beta1/serviceconsumermanagement-api.json +++ b/serviceconsumermanagement/v1beta1/serviceconsumermanagement-api.json @@ -500,7 +500,7 @@ } } }, - "revision": "20220615", + "revision": "20220816", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1623,6 +1623,10 @@ "description": "OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for \"Read-only access to Google Calendar\" and \"Access to Cloud Platform\". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.", "id": "OAuthRequirements", "properties": { + "allowAnyScope": { + "description": "UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api-auth@ and esf-team@ for approval and allowlisting before you enable this option. ", + "type": "boolean" + }, "canonicalScopes": { "description": "The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read", "type": "string" diff --git a/serviceconsumermanagement/v1beta1/serviceconsumermanagement-gen.go b/serviceconsumermanagement/v1beta1/serviceconsumermanagement-gen.go index 0bd58298e37..dadf0271e41 100644 --- a/serviceconsumermanagement/v1beta1/serviceconsumermanagement-gen.go +++ b/serviceconsumermanagement/v1beta1/serviceconsumermanagement-gen.go @@ -2438,6 +2438,15 @@ func (s *MonitoringDestination) MarshalJSON() ([]byte, error) { // accepted and passed to the backend, a request can still fail due to // the backend requiring additional scopes or permissions. type OAuthRequirements struct { + // AllowAnyScope: UNIMPLEMENTED: If enabled, ESF will allow OAuth + // credentials with any scope, more details in + // http://go/esf-oauth-any-scope. WARNING: Enabling this option will + // bring security risks. Customers enabling this feature accidentally + // may have the risk of losing authentication enforcement. Please reach + // out to api-auth@ and esf-team@ for approval and allowlisting before + // you enable this option. + AllowAnyScope bool `json:"allowAnyScope,omitempty"` + // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An OAuth token containing any of these scopes // will be accepted. Example: canonical_scopes: @@ -2445,7 +2454,7 @@ type OAuthRequirements struct { // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` - // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to + // ForceSendFields is a list of field names (e.g. "AllowAnyScope") 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 @@ -2453,13 +2462,12 @@ type OAuthRequirements struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CanonicalScopes") 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. "AllowAnyScope") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } diff --git a/servicenetworking/v1/servicenetworking-api.json b/servicenetworking/v1/servicenetworking-api.json index 963636bf081..a08a37dd056 100644 --- a/servicenetworking/v1/servicenetworking-api.json +++ b/servicenetworking/v1/servicenetworking-api.json @@ -865,7 +865,7 @@ } } }, - "revision": "20220720", + "revision": "20220816", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2519,6 +2519,10 @@ "description": "OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for \"Read-only access to Google Calendar\" and \"Access to Cloud Platform\". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.", "id": "OAuthRequirements", "properties": { + "allowAnyScope": { + "description": "UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api-auth@ and esf-team@ for approval and allowlisting before you enable this option. ", + "type": "boolean" + }, "canonicalScopes": { "description": "The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read", "type": "string" diff --git a/servicenetworking/v1/servicenetworking-gen.go b/servicenetworking/v1/servicenetworking-gen.go index fc1182223ff..fb34819c2bb 100644 --- a/servicenetworking/v1/servicenetworking-gen.go +++ b/servicenetworking/v1/servicenetworking-gen.go @@ -3483,6 +3483,15 @@ func (s *MonitoringDestination) MarshalJSON() ([]byte, error) { // accepted and passed to the backend, a request can still fail due to // the backend requiring additional scopes or permissions. type OAuthRequirements struct { + // AllowAnyScope: UNIMPLEMENTED: If enabled, ESF will allow OAuth + // credentials with any scope, more details in + // http://go/esf-oauth-any-scope. WARNING: Enabling this option will + // bring security risks. Customers enabling this feature accidentally + // may have the risk of losing authentication enforcement. Please reach + // out to api-auth@ and esf-team@ for approval and allowlisting before + // you enable this option. + AllowAnyScope bool `json:"allowAnyScope,omitempty"` + // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An OAuth token containing any of these scopes // will be accepted. Example: canonical_scopes: @@ -3490,7 +3499,7 @@ type OAuthRequirements struct { // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` - // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to + // ForceSendFields is a list of field names (e.g. "AllowAnyScope") 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 @@ -3498,13 +3507,12 @@ type OAuthRequirements struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CanonicalScopes") 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. "AllowAnyScope") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } diff --git a/servicenetworking/v1beta/servicenetworking-api.json b/servicenetworking/v1beta/servicenetworking-api.json index 89fb46c692e..163e1e56aea 100644 --- a/servicenetworking/v1beta/servicenetworking-api.json +++ b/servicenetworking/v1beta/servicenetworking-api.json @@ -307,7 +307,7 @@ } } }, - "revision": "20220720", + "revision": "20220816", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1777,6 +1777,10 @@ "description": "OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for \"Read-only access to Google Calendar\" and \"Access to Cloud Platform\". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.", "id": "OAuthRequirements", "properties": { + "allowAnyScope": { + "description": "UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api-auth@ and esf-team@ for approval and allowlisting before you enable this option. ", + "type": "boolean" + }, "canonicalScopes": { "description": "The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read", "type": "string" diff --git a/servicenetworking/v1beta/servicenetworking-gen.go b/servicenetworking/v1beta/servicenetworking-gen.go index 2f58e01d356..4d31ce42ac0 100644 --- a/servicenetworking/v1beta/servicenetworking-gen.go +++ b/servicenetworking/v1beta/servicenetworking-gen.go @@ -2994,6 +2994,15 @@ func (s *MonitoringDestination) MarshalJSON() ([]byte, error) { // accepted and passed to the backend, a request can still fail due to // the backend requiring additional scopes or permissions. type OAuthRequirements struct { + // AllowAnyScope: UNIMPLEMENTED: If enabled, ESF will allow OAuth + // credentials with any scope, more details in + // http://go/esf-oauth-any-scope. WARNING: Enabling this option will + // bring security risks. Customers enabling this feature accidentally + // may have the risk of losing authentication enforcement. Please reach + // out to api-auth@ and esf-team@ for approval and allowlisting before + // you enable this option. + AllowAnyScope bool `json:"allowAnyScope,omitempty"` + // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An OAuth token containing any of these scopes // will be accepted. Example: canonical_scopes: @@ -3001,7 +3010,7 @@ type OAuthRequirements struct { // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` - // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to + // ForceSendFields is a list of field names (e.g. "AllowAnyScope") 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 @@ -3009,13 +3018,12 @@ type OAuthRequirements struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CanonicalScopes") 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. "AllowAnyScope") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } diff --git a/serviceusage/v1/serviceusage-api.json b/serviceusage/v1/serviceusage-api.json index 0d5bff2081c..f3a7f1db500 100644 --- a/serviceusage/v1/serviceusage-api.json +++ b/serviceusage/v1/serviceusage-api.json @@ -426,7 +426,7 @@ } } }, - "revision": "20220615", + "revision": "20220816", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -2153,6 +2153,10 @@ "description": "OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for \"Read-only access to Google Calendar\" and \"Access to Cloud Platform\". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.", "id": "OAuthRequirements", "properties": { + "allowAnyScope": { + "description": "UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api-auth@ and esf-team@ for approval and allowlisting before you enable this option. ", + "type": "boolean" + }, "canonicalScopes": { "description": "The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read", "type": "string" diff --git a/serviceusage/v1/serviceusage-gen.go b/serviceusage/v1/serviceusage-gen.go index 5b7c24d8c33..9cdfbd8be24 100644 --- a/serviceusage/v1/serviceusage-gen.go +++ b/serviceusage/v1/serviceusage-gen.go @@ -3406,6 +3406,15 @@ func (s *MonitoringDestination) MarshalJSON() ([]byte, error) { // accepted and passed to the backend, a request can still fail due to // the backend requiring additional scopes or permissions. type OAuthRequirements struct { + // AllowAnyScope: UNIMPLEMENTED: If enabled, ESF will allow OAuth + // credentials with any scope, more details in + // http://go/esf-oauth-any-scope. WARNING: Enabling this option will + // bring security risks. Customers enabling this feature accidentally + // may have the risk of losing authentication enforcement. Please reach + // out to api-auth@ and esf-team@ for approval and allowlisting before + // you enable this option. + AllowAnyScope bool `json:"allowAnyScope,omitempty"` + // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An OAuth token containing any of these scopes // will be accepted. Example: canonical_scopes: @@ -3413,7 +3422,7 @@ type OAuthRequirements struct { // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` - // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to + // ForceSendFields is a list of field names (e.g. "AllowAnyScope") 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 @@ -3421,13 +3430,12 @@ type OAuthRequirements struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CanonicalScopes") 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. "AllowAnyScope") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } diff --git a/serviceusage/v1beta1/serviceusage-api.json b/serviceusage/v1beta1/serviceusage-api.json index 57a210acba5..a264c332fd5 100644 --- a/serviceusage/v1beta1/serviceusage-api.json +++ b/serviceusage/v1beta1/serviceusage-api.json @@ -959,7 +959,7 @@ } } }, - "revision": "20220615", + "revision": "20220816", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -2843,6 +2843,10 @@ "description": "OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for \"Read-only access to Google Calendar\" and \"Access to Cloud Platform\". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.", "id": "OAuthRequirements", "properties": { + "allowAnyScope": { + "description": "UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api-auth@ and esf-team@ for approval and allowlisting before you enable this option. ", + "type": "boolean" + }, "canonicalScopes": { "description": "The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read", "type": "string" diff --git a/serviceusage/v1beta1/serviceusage-gen.go b/serviceusage/v1beta1/serviceusage-gen.go index ae33f868ad9..148c33d7139 100644 --- a/serviceusage/v1beta1/serviceusage-gen.go +++ b/serviceusage/v1beta1/serviceusage-gen.go @@ -3705,6 +3705,15 @@ func (s *MonitoringDestination) MarshalJSON() ([]byte, error) { // accepted and passed to the backend, a request can still fail due to // the backend requiring additional scopes or permissions. type OAuthRequirements struct { + // AllowAnyScope: UNIMPLEMENTED: If enabled, ESF will allow OAuth + // credentials with any scope, more details in + // http://go/esf-oauth-any-scope. WARNING: Enabling this option will + // bring security risks. Customers enabling this feature accidentally + // may have the risk of losing authentication enforcement. Please reach + // out to api-auth@ and esf-team@ for approval and allowlisting before + // you enable this option. + AllowAnyScope bool `json:"allowAnyScope,omitempty"` + // CanonicalScopes: The list of publicly documented OAuth scopes that // are allowed access. An OAuth token containing any of these scopes // will be accepted. Example: canonical_scopes: @@ -3712,7 +3721,7 @@ type OAuthRequirements struct { // https://www.googleapis.com/auth/calendar.read CanonicalScopes string `json:"canonicalScopes,omitempty"` - // ForceSendFields is a list of field names (e.g. "CanonicalScopes") to + // ForceSendFields is a list of field names (e.g. "AllowAnyScope") 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 @@ -3720,13 +3729,12 @@ type OAuthRequirements struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CanonicalScopes") 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. "AllowAnyScope") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } diff --git a/transcoder/v1/transcoder-api.json b/transcoder/v1/transcoder-api.json index 02bbb4f1fac..fb354e677bb 100644 --- a/transcoder/v1/transcoder-api.json +++ b/transcoder/v1/transcoder-api.json @@ -385,7 +385,7 @@ } } }, - "revision": "20220609", + "revision": "20220811", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { @@ -577,6 +577,25 @@ }, "type": "object" }, + "BwdifConfig": { + "description": "Bob Weaver Deinterlacing Filter Configuration.", + "id": "BwdifConfig", + "properties": { + "deinterlaceAllFrames": { + "description": "Deinterlace all frames rather than just the frames identified as interlaced. The default is `false`.", + "type": "boolean" + }, + "mode": { + "description": "Specifies the deinterlacing mode to adopt. The default is `send_frame`. Supported values: - `send_frame`: Output one frame for each frame - `send_field`: Output one frame for each field", + "type": "string" + }, + "parity": { + "description": "The picture field parity assumed for the input interlaced video. The default is `auto`. Supported values: - `tff`: Assume the top field is first - `bff`: Assume the bottom field is first - `auto`: Enable automatic detection of field parity", + "type": "string" + } + }, + "type": "object" + }, "Color": { "description": "Color preprocessing configuration. **Note:** This configuration is not supported.", "id": "Color", @@ -642,6 +661,21 @@ }, "type": "object" }, + "Deinterlace": { + "description": "Deinterlace configuration for input video.", + "id": "Deinterlace", + "properties": { + "bwdif": { + "$ref": "BwdifConfig", + "description": "Specifies the Bob Weaver Deinterlacing Filter Configuration." + }, + "yadif": { + "$ref": "YadifConfig", + "description": "Specifies the Yet Another Deinterlacing Filter Configuration." + } + }, + "type": "object" + }, "Denoise": { "description": "Denoise preprocessing configuration. **Note:** This configuration is not supported.", "id": "Denoise", @@ -1325,6 +1359,10 @@ "$ref": "Deblock", "description": "Deblock preprocessing configuration." }, + "deinterlace": { + "$ref": "Deinterlace", + "description": "Specify the video deinterlace configuration." + }, "denoise": { "$ref": "Denoise", "description": "Denoise preprocessing configuration." @@ -1560,6 +1598,29 @@ } }, "type": "object" + }, + "YadifConfig": { + "description": "Yet Another Deinterlacing Filter Configuration.", + "id": "YadifConfig", + "properties": { + "deinterlaceAllFrames": { + "description": "Deinterlace all frames rather than just the frames identified as interlaced. The default is `false`.", + "type": "boolean" + }, + "disableSpatialInterlacing": { + "description": "Disable spacial interlacing. The default is `false`.", + "type": "boolean" + }, + "mode": { + "description": "Specifies the deinterlacing mode to adopt. The default is `send_frame`. Supported values: - `send_frame`: Output one frame for each frame - `send_field`: Output one frame for each field", + "type": "string" + }, + "parity": { + "description": "The picture field parity assumed for the input interlaced video. The default is `auto`. Supported values: - `tff`: Assume the top field is first - `bff`: Assume the bottom field is first - `auto`: Enable automatic detection of field parity", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/transcoder/v1/transcoder-gen.go b/transcoder/v1/transcoder-gen.go index 94c88ed2b29..a773238ebab 100644 --- a/transcoder/v1/transcoder-gen.go +++ b/transcoder/v1/transcoder-gen.go @@ -537,6 +537,48 @@ func (s *AudioStream) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// BwdifConfig: Bob Weaver Deinterlacing Filter Configuration. +type BwdifConfig struct { + // DeinterlaceAllFrames: Deinterlace all frames rather than just the + // frames identified as interlaced. The default is `false`. + DeinterlaceAllFrames bool `json:"deinterlaceAllFrames,omitempty"` + + // Mode: Specifies the deinterlacing mode to adopt. The default is + // `send_frame`. Supported values: - `send_frame`: Output one frame for + // each frame - `send_field`: Output one frame for each field + Mode string `json:"mode,omitempty"` + + // Parity: The picture field parity assumed for the input interlaced + // video. The default is `auto`. Supported values: - `tff`: Assume the + // top field is first - `bff`: Assume the bottom field is first - + // `auto`: Enable automatic detection of field parity + Parity string `json:"parity,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DeinterlaceAllFrames") 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. "DeinterlaceAllFrames") 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 *BwdifConfig) MarshalJSON() ([]byte, error) { + type NoMethod BwdifConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Color: Color preprocessing configuration. **Note:** This // configuration is not supported. type Color struct { @@ -686,6 +728,37 @@ func (s *Deblock) UnmarshalJSON(data []byte) error { return nil } +// Deinterlace: Deinterlace configuration for input video. +type Deinterlace struct { + // Bwdif: Specifies the Bob Weaver Deinterlacing Filter Configuration. + Bwdif *BwdifConfig `json:"bwdif,omitempty"` + + // Yadif: Specifies the Yet Another Deinterlacing Filter Configuration. + Yadif *YadifConfig `json:"yadif,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Bwdif") 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. "Bwdif") 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 *Deinterlace) MarshalJSON() ([]byte, error) { + type NoMethod Deinterlace + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Denoise: Denoise preprocessing configuration. **Note:** This // configuration is not supported. type Denoise struct { @@ -1761,6 +1834,9 @@ type PreprocessingConfig struct { // Deblock: Deblock preprocessing configuration. Deblock *Deblock `json:"deblock,omitempty"` + // Deinterlace: Specify the video deinterlace configuration. + Deinterlace *Deinterlace `json:"deinterlace,omitempty"` + // Denoise: Denoise preprocessing configuration. Denoise *Denoise `json:"denoise,omitempty"` @@ -2186,6 +2262,52 @@ func (s *Vp9CodecSettings) UnmarshalJSON(data []byte) error { return nil } +// YadifConfig: Yet Another Deinterlacing Filter Configuration. +type YadifConfig struct { + // DeinterlaceAllFrames: Deinterlace all frames rather than just the + // frames identified as interlaced. The default is `false`. + DeinterlaceAllFrames bool `json:"deinterlaceAllFrames,omitempty"` + + // DisableSpatialInterlacing: Disable spacial interlacing. The default + // is `false`. + DisableSpatialInterlacing bool `json:"disableSpatialInterlacing,omitempty"` + + // Mode: Specifies the deinterlacing mode to adopt. The default is + // `send_frame`. Supported values: - `send_frame`: Output one frame for + // each frame - `send_field`: Output one frame for each field + Mode string `json:"mode,omitempty"` + + // Parity: The picture field parity assumed for the input interlaced + // video. The default is `auto`. Supported values: - `tff`: Assume the + // top field is first - `bff`: Assume the bottom field is first - + // `auto`: Enable automatic detection of field parity + Parity string `json:"parity,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DeinterlaceAllFrames") 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. "DeinterlaceAllFrames") 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 *YadifConfig) MarshalJSON() ([]byte, error) { + type NoMethod YadifConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // method id "transcoder.projects.locations.jobTemplates.create": type ProjectsLocationsJobTemplatesCreateCall struct {