From 380eafd8ae92e184a2621c9ae73bc967e6829fec Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Fri, 30 Jun 2023 00:24:12 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2044) --- cloudbilling/v1/cloudbilling-api.json | 8 +- cloudbilling/v1/cloudbilling-gen.go | 6 +- cloudbuild/v1/cloudbuild-api.json | 8 +- cloudbuild/v1/cloudbuild-gen.go | 1 + cloudchannel/v1/cloudchannel-api.json | 12 +- cloudchannel/v1/cloudchannel-gen.go | 62 +- container/v1/container-api.json | 63 +- container/v1/container-gen.go | 135 ++++- container/v1beta1/container-api.json | 87 ++- container/v1beta1/container-gen.go | 161 +++++- content/v2.1/content-api.json | 32 +- content/v2.1/content-gen.go | 58 ++ .../v1/essentialcontacts-api.json | 116 +++- essentialcontacts/v1/essentialcontacts-gen.go | 117 +++- pubsub/v1/pubsub-api.json | 176 +++--- pubsub/v1/pubsub-gen.go | 541 +++++++++--------- vmmigration/v1/vmmigration-api.json | 3 +- vmmigration/v1alpha1/vmmigration-api.json | 25 +- 18 files changed, 1154 insertions(+), 457 deletions(-) diff --git a/cloudbilling/v1/cloudbilling-api.json b/cloudbilling/v1/cloudbilling-api.json index 649616efdf2..173c1488d66 100644 --- a/cloudbilling/v1/cloudbilling-api.json +++ b/cloudbilling/v1/cloudbilling-api.json @@ -521,7 +521,7 @@ } } }, - "revision": "20230616", + "revision": "20230629", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { @@ -935,17 +935,17 @@ "type": "string" }, "billingEnabled": { - "description": "Output only. True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.", + "description": "Output only. True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services.", "readOnly": true, "type": "boolean" }, "name": { - "description": "Output only. The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only.", + "description": "Output only. The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`.", "readOnly": true, "type": "string" }, "projectId": { - "description": "Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only.", + "description": "Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID.", "readOnly": true, "type": "string" } diff --git a/cloudbilling/v1/cloudbilling-gen.go b/cloudbilling/v1/cloudbilling-gen.go index f6b6766981b..fa27ac4b88e 100644 --- a/cloudbilling/v1/cloudbilling-gen.go +++ b/cloudbilling/v1/cloudbilling-gen.go @@ -1096,20 +1096,18 @@ type ProjectBillingInfo struct { // an open billing account, to which usage on the project is charged. // False if the project is associated with a closed billing account, or // no billing account at all, and therefore cannot use paid services. - // This field is read-only. BillingEnabled bool `json:"billingEnabled,omitempty"` // Name: Output only. The resource name for the `ProjectBillingInfo`; // has the form `projects/{project_id}/billingInfo`. For example, the // resource name for the billing information for project - // `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This - // field is read-only. + // `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. Name string `json:"name,omitempty"` // ProjectId: Output only. The ID of the project that this // `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a // convenience field so that you don't need to parse the `name` field to - // obtain a project ID. This field is read-only. + // obtain a project ID. ProjectId string `json:"projectId,omitempty"` // ServerResponse contains the HTTP response code and headers from the diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json index 72f447ad76e..6f4697b9d3d 100644 --- a/cloudbuild/v1/cloudbuild-api.json +++ b/cloudbuild/v1/cloudbuild-api.json @@ -2319,7 +2319,7 @@ } } }, - "revision": "20230522", + "revision": "20230626", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3043,14 +3043,16 @@ "N1_HIGHCPU_8", "N1_HIGHCPU_32", "E2_HIGHCPU_8", - "E2_HIGHCPU_32" + "E2_HIGHCPU_32", + "E2_MEDIUM" ], "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", "Highcpu machine with 32 CPUs.", "Highcpu e2 machine with 8 CPUs.", - "Highcpu e2 machine with 32 CPUs." + "Highcpu e2 machine with 32 CPUs.", + "E2 machine with 1 CPU." ], "type": "string" }, diff --git a/cloudbuild/v1/cloudbuild-gen.go b/cloudbuild/v1/cloudbuild-gen.go index e6756a7f046..5ea57d4035d 100644 --- a/cloudbuild/v1/cloudbuild-gen.go +++ b/cloudbuild/v1/cloudbuild-gen.go @@ -1446,6 +1446,7 @@ type BuildOptions struct { // "N1_HIGHCPU_32" - Highcpu machine with 32 CPUs. // "E2_HIGHCPU_8" - Highcpu e2 machine with 8 CPUs. // "E2_HIGHCPU_32" - Highcpu e2 machine with 32 CPUs. + // "E2_MEDIUM" - E2 machine with 1 CPU. MachineType string `json:"machineType,omitempty"` // Pool: Optional. Specification for execution on a `WorkerPool`. See diff --git a/cloudchannel/v1/cloudchannel-api.json b/cloudchannel/v1/cloudchannel-api.json index 8cfab748937..19d2b388fae 100644 --- a/cloudchannel/v1/cloudchannel-api.json +++ b/cloudchannel/v1/cloudchannel-api.json @@ -593,7 +593,7 @@ "customers": { "methods": { "create": { - "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", + "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers", "httpMethod": "POST", "id": "cloudchannel.accounts.channelPartnerLinks.customers.create", @@ -671,7 +671,7 @@ ] }, "import": { - "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", + "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers:import", "httpMethod": "POST", "id": "cloudchannel.accounts.channelPartnerLinks.customers.import", @@ -780,7 +780,7 @@ "customers": { "methods": { "create": { - "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", + "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", "flatPath": "v1/accounts/{accountsId}/customers", "httpMethod": "POST", "id": "cloudchannel.accounts.customers.create", @@ -858,7 +858,7 @@ ] }, "import": { - "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", + "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", "flatPath": "v1/accounts/{accountsId}/customers:import", "httpMethod": "POST", "id": "cloudchannel.accounts.customers.import", @@ -1093,7 +1093,7 @@ ] }, "provisionCloudIdentity": { - "description": "Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.", + "description": "Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * PERMISSION_DENIED: You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.", "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:provisionCloudIdentity", "httpMethod": "POST", "id": "cloudchannel.accounts.customers.provisionCloudIdentity", @@ -2178,7 +2178,7 @@ } } }, - "revision": "20230613", + "revision": "20230628", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/cloudchannel/v1/cloudchannel-gen.go b/cloudchannel/v1/cloudchannel-gen.go index 9623ad370d7..4e9f9ad6153 100644 --- a/cloudchannel/v1/cloudchannel-gen.go +++ b/cloudchannel/v1/cloudchannel-gen.go @@ -9130,10 +9130,12 @@ type AccountsChannelPartnerLinksCustomersCreateCall struct { // Create: Creates a new Customer resource under the reseller or // distributor account. Possible error codes: * PERMISSION_DENIED: The // reseller account making the request is different from the reseller -// account in the API request. * INVALID_ARGUMENT: * Required request -// parameters are missing or invalid. * Domain field value doesn't match -// the primary email domain. Return value: The newly created Customer -// resource. +// account in the API request. * PERMISSION_DENIED: You are not +// authorized to create a customer. See +// https://support.google.com/channelservices/answer/9759265 * +// INVALID_ARGUMENT: * Required request parameters are missing or +// invalid. * Domain field value doesn't match the primary email domain. +// Return value: The newly created Customer resource. // // - parent: The resource name of reseller account in which to create // the customer. Parent uses the format: accounts/{account_id}. @@ -9235,7 +9237,7 @@ func (c *AccountsChannelPartnerLinksCustomersCreateCall) Do(opts ...googleapi.Ca } return ret, nil // { - // "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", + // "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", // "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers", // "httpMethod": "POST", // "id": "cloudchannel.accounts.channelPartnerLinks.customers.create", @@ -9571,7 +9573,10 @@ type AccountsChannelPartnerLinksCustomersImportCall struct { // overwrite_if_exists is true, it will update that Customer's data. // Possible error codes: * PERMISSION_DENIED: The reseller account // making the request is different from the reseller account in the API -// request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * +// request. * PERMISSION_DENIED: You are not authorized to import the +// customer. See +// https://support.google.com/channelservices/answer/9759265 * +// NOT_FOUND: Cloud Identity doesn't exist or was deleted. * // INVALID_ARGUMENT: Required parameters are missing, or the auth_token // is expired or invalid. * ALREADY_EXISTS: A customer already exists // and has conflicting critical fields. Requires an overwrite. Return @@ -9678,7 +9683,7 @@ func (c *AccountsChannelPartnerLinksCustomersImportCall) Do(opts ...googleapi.Ca } return ret, nil // { - // "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", + // "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", // "flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers:import", // "httpMethod": "POST", // "id": "cloudchannel.accounts.channelPartnerLinks.customers.import", @@ -10100,10 +10105,12 @@ type AccountsCustomersCreateCall struct { // Create: Creates a new Customer resource under the reseller or // distributor account. Possible error codes: * PERMISSION_DENIED: The // reseller account making the request is different from the reseller -// account in the API request. * INVALID_ARGUMENT: * Required request -// parameters are missing or invalid. * Domain field value doesn't match -// the primary email domain. Return value: The newly created Customer -// resource. +// account in the API request. * PERMISSION_DENIED: You are not +// authorized to create a customer. See +// https://support.google.com/channelservices/answer/9759265 * +// INVALID_ARGUMENT: * Required request parameters are missing or +// invalid. * Domain field value doesn't match the primary email domain. +// Return value: The newly created Customer resource. // // - parent: The resource name of reseller account in which to create // the customer. Parent uses the format: accounts/{account_id}. @@ -10205,7 +10212,7 @@ func (c *AccountsCustomersCreateCall) Do(opts ...googleapi.CallOption) (*GoogleC } return ret, nil // { - // "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", + // "description": "Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.", // "flatPath": "v1/accounts/{accountsId}/customers", // "httpMethod": "POST", // "id": "cloudchannel.accounts.customers.create", @@ -10541,7 +10548,10 @@ type AccountsCustomersImportCall struct { // overwrite_if_exists is true, it will update that Customer's data. // Possible error codes: * PERMISSION_DENIED: The reseller account // making the request is different from the reseller account in the API -// request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * +// request. * PERMISSION_DENIED: You are not authorized to import the +// customer. See +// https://support.google.com/channelservices/answer/9759265 * +// NOT_FOUND: Cloud Identity doesn't exist or was deleted. * // INVALID_ARGUMENT: Required parameters are missing, or the auth_token // is expired or invalid. * ALREADY_EXISTS: A customer already exists // and has conflicting critical fields. Requires an overwrite. Return @@ -10648,7 +10658,7 @@ func (c *AccountsCustomersImportCall) Do(opts ...googleapi.CallOption) (*GoogleC } return ret, nil // { - // "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", + // "description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * PERMISSION_DENIED: You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.", // "flatPath": "v1/accounts/{accountsId}/customers:import", // "httpMethod": "POST", // "id": "cloudchannel.accounts.customers.import", @@ -11633,17 +11643,19 @@ type AccountsCustomersProvisionCloudIdentityCall struct { // ProvisionCloudIdentity: Creates a Cloud Identity for the given // customer using the customer's information, or the information // provided here. Possible error codes: * PERMISSION_DENIED: The -// customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required -// request parameters are missing or invalid. * NOT_FOUND: The customer -// was not found. * ALREADY_EXISTS: The customer's primary email already -// exists. Retry after changing the customer's primary contact email. * -// INTERNAL: Any non-user error related to a technical issue in the -// backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error +// customer doesn't belong to the reseller. * PERMISSION_DENIED: You are +// not authorized to provision cloud identity id. See +// https://support.google.com/channelservices/answer/9759265 * +// INVALID_ARGUMENT: Required request parameters are missing or invalid. +// * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The +// customer's primary email already exists. Retry after changing the +// customer's primary contact email. * INTERNAL: Any non-user error // related to a technical issue in the backend. Contact Cloud Channel -// support. Return value: The ID of a long-running operation. To get the -// results of the operation, call the GetOperation method of -// CloudChannelOperationsService. The Operation metadata contains an -// instance of OperationMetadata. +// support. * UNKNOWN: Any non-user error related to a technical issue +// in the backend. Contact Cloud Channel support. Return value: The ID +// of a long-running operation. To get the results of the operation, +// call the GetOperation method of CloudChannelOperationsService. The +// Operation metadata contains an instance of OperationMetadata. // // - customer: Resource name of the customer. Format: // accounts/{account_id}/customers/{customer_id}. @@ -11745,7 +11757,7 @@ func (c *AccountsCustomersProvisionCloudIdentityCall) Do(opts ...googleapi.CallO } return ret, nil // { - // "description": "Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.", + // "description": "Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * PERMISSION_DENIED: You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265 * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata.", // "flatPath": "v1/accounts/{accountsId}/customers/{customersId}:provisionCloudIdentity", // "httpMethod": "POST", // "id": "cloudchannel.accounts.customers.provisionCloudIdentity", diff --git a/container/v1/container-api.json b/container/v1/container-api.json index 2d9de1ea28f..45d258e3f98 100644 --- a/container/v1/container-api.json +++ b/container/v1/container-api.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20230614", + "revision": "20230620", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2575,6 +2575,14 @@ "description": "AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.", "id": "AdditionalPodRangesConfig", "properties": { + "podRangeInfo": { + "description": "Output only. [Output only] Information for additional pod range.", + "items": { + "$ref": "RangeInfo" + }, + "readOnly": true, + "type": "array" + }, "podRangeNames": { "description": "Name for pod secondary ipv4 range which has the actual range defined ahead.", "items": { @@ -2609,6 +2617,10 @@ "$ref": "GcpFilestoreCsiDriverConfig", "description": "Configuration for the GCP Filestore CSI driver." }, + "gcsFuseCsiDriverConfig": { + "$ref": "GcsFuseCsiDriverConfig", + "description": "Configuration for the Cloud Storage Fuse CSI driver." + }, "gkeBackupAgentConfig": { "$ref": "GkeBackupAgentConfig", "description": "Configuration for the Backup for GKE agent addon." @@ -2757,6 +2769,10 @@ "description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, + "insecureKubeletReadonlyPortEnabled": { + "description": "Enable or disable Kubelet read only port.", + "type": "boolean" + }, "management": { "$ref": "NodeManagement", "description": "Specifies the node management options for NAP created node-pools." @@ -4011,6 +4027,17 @@ }, "type": "object" }, + "GcsFuseCsiDriverConfig": { + "description": "Configuration for the Cloud Storage Fuse CSI driver.", + "id": "GcsFuseCsiDriverConfig", + "properties": { + "enabled": { + "description": "Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.", + "type": "boolean" + } + }, + "type": "object" + }, "GetJSONWebKeysResponse": { "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", "id": "GetJSONWebKeysResponse", @@ -4172,6 +4199,12 @@ "description": "Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.", "type": "boolean" }, + "defaultPodIpv4RangeUtilization": { + "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "format": "double", + "readOnly": true, + "type": "number" + }, "ipv6AccessType": { "description": "The ipv6 access type (internal or external) when create_subnetwork is true", "enum": [ @@ -5116,6 +5149,10 @@ "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" }, + "insecureKubeletReadonlyPortEnabled": { + "description": "Enable or disable Kubelet read only port.", + "type": "boolean" + }, "podPidsLimit": { "description": "Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.", "format": "int64", @@ -5181,6 +5218,12 @@ "description": "The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "string" }, + "podIpv4RangeUtilization": { + "description": "Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "format": "double", + "readOnly": true, + "type": "number" + }, "podRange": { "description": "The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "string" @@ -5714,6 +5757,24 @@ }, "type": "object" }, + "RangeInfo": { + "description": "RangeInfo contains the range name and the range utilization by this cluster.", + "id": "RangeInfo", + "properties": { + "rangeName": { + "description": "Output only. [Output only] Name of a range.", + "readOnly": true, + "type": "string" + }, + "utilization": { + "description": "Output only. [Output only] The utilization of the range.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", diff --git a/container/v1/container-gen.go b/container/v1/container-gen.go index 8f088024d6b..a6368a67be7 100644 --- a/container/v1/container-gen.go +++ b/container/v1/container-gen.go @@ -331,11 +331,15 @@ func (s *AcceleratorConfig) MarshalJSON() ([]byte, error) { // configuration for additional pod secondary ranges supporting the // ClusterUpdate message. type AdditionalPodRangesConfig struct { + // PodRangeInfo: Output only. [Output only] Information for additional + // pod range. + PodRangeInfo []*RangeInfo `json:"podRangeInfo,omitempty"` + // PodRangeNames: Name for pod secondary ipv4 range which has the actual // range defined ahead. PodRangeNames []string `json:"podRangeNames,omitempty"` - // ForceSendFields is a list of field names (e.g. "PodRangeNames") to + // ForceSendFields is a list of field names (e.g. "PodRangeInfo") 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 @@ -343,7 +347,7 @@ type AdditionalPodRangesConfig struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "PodRangeNames") to include + // NullFields is a list of field names (e.g. "PodRangeInfo") 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 @@ -382,6 +386,10 @@ type AddonsConfig struct { // driver. GcpFilestoreCsiDriverConfig *GcpFilestoreCsiDriverConfig `json:"gcpFilestoreCsiDriverConfig,omitempty"` + // GcsFuseCsiDriverConfig: Configuration for the Cloud Storage Fuse CSI + // driver. + GcsFuseCsiDriverConfig *GcsFuseCsiDriverConfig `json:"gcsFuseCsiDriverConfig,omitempty"` + // GkeBackupAgentConfig: Configuration for the Backup for GKE agent // addon. GkeBackupAgentConfig *GkeBackupAgentConfig `json:"gkeBackupAgentConfig,omitempty"` @@ -653,6 +661,10 @@ type AutoprovisioningNodePoolDefaults struct { // for available image types. ImageType string `json:"imageType,omitempty"` + // InsecureKubeletReadonlyPortEnabled: Enable or disable Kubelet read + // only port. + InsecureKubeletReadonlyPortEnabled bool `json:"insecureKubeletReadonlyPortEnabled,omitempty"` + // Management: Specifies the node management options for NAP created // node-pools. Management *NodeManagement `json:"management,omitempty"` @@ -2655,6 +2667,36 @@ func (s *GcpFilestoreCsiDriverConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GcsFuseCsiDriverConfig: Configuration for the Cloud Storage Fuse CSI +// driver. +type GcsFuseCsiDriverConfig struct { + // Enabled: Whether the Cloud Storage Fuse CSI driver is enabled for + // this cluster. + Enabled bool `json:"enabled,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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 *GcsFuseCsiDriverConfig) MarshalJSON() ([]byte, error) { + type NoMethod GcsFuseCsiDriverConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GetJSONWebKeysResponse: GetJSONWebKeysResponse is a valid JSON Web // Key Set as specififed in rfc 7517 type GetJSONWebKeysResponse struct { @@ -2945,6 +2987,12 @@ type IPAllocationPolicy struct { // `use_ip_aliases` is true. CreateSubnetwork bool `json:"createSubnetwork,omitempty"` + // DefaultPodIpv4RangeUtilization: Output only. [Output only] The + // utilization of the cluster default IPv4 range for pod. The ratio is + // Usage/[Total number of IPs in the secondary range], + // Usage=numNodes*numZones*podIPsPerNode. + DefaultPodIpv4RangeUtilization float64 `json:"defaultPodIpv4RangeUtilization,omitempty"` + // Ipv6AccessType: The ipv6 access type (internal or external) when // create_subnetwork is true // @@ -3076,6 +3124,20 @@ func (s *IPAllocationPolicy) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +func (s *IPAllocationPolicy) UnmarshalJSON(data []byte) error { + type NoMethod IPAllocationPolicy + var s1 struct { + DefaultPodIpv4RangeUtilization gensupport.JSONFloat64 `json:"defaultPodIpv4RangeUtilization"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.DefaultPodIpv4RangeUtilization = float64(s1.DefaultPodIpv4RangeUtilization) + return nil +} + // IdentityServiceConfig: IdentityServiceConfig is configuration for // Identity Service which allows customers to use external identity // providers with the K8S API @@ -4597,6 +4659,10 @@ type NodeKubeletConfig struct { // unspecified. CpuManagerPolicy string `json:"cpuManagerPolicy,omitempty"` + // InsecureKubeletReadonlyPortEnabled: Enable or disable Kubelet read + // only port. + InsecureKubeletReadonlyPortEnabled bool `json:"insecureKubeletReadonlyPortEnabled,omitempty"` + // PodPidsLimit: Set the Pod PID limits. See // https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits // Controls the maximum number of processes allowed to run in a pod. The @@ -4736,6 +4802,11 @@ type NodeNetworkConfig struct { // field cannot be changed after the node pool has been created. PodIpv4CidrBlock string `json:"podIpv4CidrBlock,omitempty"` + // PodIpv4RangeUtilization: Output only. [Output only] The utilization + // of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in + // the secondary range], Usage=numNodes*numZones*podIPsPerNode. + PodIpv4RangeUtilization float64 `json:"podIpv4RangeUtilization,omitempty"` + // PodRange: The ID of the secondary range for pod IPs. If // `create_pod_range` is true, this ID is used for the new range. If // `create_pod_range` is false, uses an existing secondary range with @@ -4768,6 +4839,20 @@ func (s *NodeNetworkConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +func (s *NodeNetworkConfig) UnmarshalJSON(data []byte) error { + type NoMethod NodeNetworkConfig + var s1 struct { + PodIpv4RangeUtilization gensupport.JSONFloat64 `json:"podIpv4RangeUtilization"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.PodIpv4RangeUtilization = float64(s1.PodIpv4RangeUtilization) + return nil +} + // NodePool: NodePool contains the name and configuration for a // cluster's node pool. Node pools are a set of nodes (i.e. VM's), with // a common configuration and specification, under the control of the @@ -5599,6 +5684,52 @@ func (s *PubSub) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// RangeInfo: RangeInfo contains the range name and the range +// utilization by this cluster. +type RangeInfo struct { + // RangeName: Output only. [Output only] Name of a range. + RangeName string `json:"rangeName,omitempty"` + + // Utilization: Output only. [Output only] The utilization of the range. + Utilization float64 `json:"utilization,omitempty"` + + // ForceSendFields is a list of field names (e.g. "RangeName") 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. "RangeName") 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 *RangeInfo) MarshalJSON() ([]byte, error) { + type NoMethod RangeInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *RangeInfo) UnmarshalJSON(data []byte) error { + type NoMethod RangeInfo + var s1 struct { + Utilization gensupport.JSONFloat64 `json:"utilization"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Utilization = float64(s1.Utilization) + return nil +} + // RecurringTimeWindow: Represents an arbitrary window of time that // recurs. type RecurringTimeWindow struct { diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json index a733be120b1..20feabdedf1 100644 --- a/container/v1beta1/container-api.json +++ b/container/v1beta1/container-api.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20230522", + "revision": "20230613", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2605,6 +2605,14 @@ "description": "AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.", "id": "AdditionalPodRangesConfig", "properties": { + "podRangeInfo": { + "description": "Output only. [Output only] Information for additional pod range.", + "items": { + "$ref": "RangeInfo" + }, + "readOnly": true, + "type": "array" + }, "podRangeNames": { "description": "Name for pod secondary ipv4 range which has the actual range defined ahead.", "items": { @@ -2799,6 +2807,10 @@ "description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, + "insecureKubeletReadonlyPortEnabled": { + "description": "Enable or disable Kubelet read only port.", + "type": "boolean" + }, "management": { "$ref": "NodeManagement", "description": "NodeManagement configuration for this NodePool." @@ -3444,6 +3456,25 @@ }, "type": "object" }, + "ClusterNetworkPerformanceConfig": { + "description": "Configuration of all network bandwidth tiers", + "id": "ClusterNetworkPerformanceConfig", + "properties": { + "totalEgressBandwidthTier": { + "description": "Specifies the total network bandwidth tier for the NodePool.", + "enum": [ + "TIER_UNSPECIFIED", + "TIER_1" + ], + "enumDescriptions": [ + "Default value", + "Higher bandwidth, actual values based on VM size." + ], + "type": "string" + } + }, + "type": "object" + }, "ClusterTelemetry": { "description": "Telemetry integration for the cluster.", "id": "ClusterTelemetry", @@ -3608,6 +3639,10 @@ "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, + "desiredNetworkPerformanceConfig": { + "$ref": "ClusterNetworkPerformanceConfig", + "description": "The desired network performance config." + }, "desiredNodePoolAutoConfigNetworkTags": { "$ref": "NetworkTags", "description": "The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters." @@ -3861,12 +3896,14 @@ "enum": [ "PROVIDER_UNSPECIFIED", "PLATFORM_DEFAULT", - "CLOUD_DNS" + "CLOUD_DNS", + "KUBE_DNS" ], "enumDescriptions": [ "Default value", "Use GKE default DNS provider(kube-dns) for DNS resolution.", - "Use CloudDNS for DNS resolution." + "Use CloudDNS for DNS resolution.", + "Use KubeDNS for DNS resolution" ], "type": "string" }, @@ -4340,6 +4377,12 @@ "description": "Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.", "type": "boolean" }, + "defaultPodIpv4RangeUtilization": { + "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "format": "double", + "readOnly": true, + "type": "number" + }, "ipv6AccessType": { "description": "The ipv6 access type (internal or external) when create_subnetwork is true", "enum": [ @@ -5045,6 +5088,10 @@ "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "type": "string" }, + "networkPerformanceConfig": { + "$ref": "ClusterNetworkPerformanceConfig", + "description": "Network bandwidth tier configuration." + }, "privateIpv6GoogleAccess": { "description": "The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)", "enum": [ @@ -5294,7 +5341,7 @@ "type": "array" }, "preemptible": { - "description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.", + "description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.", "type": "boolean" }, "reservationAffinity": { @@ -5384,6 +5431,10 @@ "description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.", "type": "string" }, + "insecureKubeletReadonlyPortEnabled": { + "description": "Enable or disable Kubelet read only port.", + "type": "boolean" + }, "podPidsLimit": { "description": "Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.", "format": "int64", @@ -5449,6 +5500,12 @@ "description": "The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "string" }, + "podIpv4RangeUtilization": { + "description": "Output only. [Output only] The utilization of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "format": "double", + "readOnly": true, + "type": "number" + }, "podRange": { "description": "The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", "type": "string" @@ -5887,6 +5944,10 @@ "description": "PlacementPolicy defines the placement policy used by the node pool.", "id": "PlacementPolicy", "properties": { + "tpuTopology": { + "description": "TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies", + "type": "string" + }, "type": { "description": "The type of placement.", "enum": [ @@ -6018,6 +6079,24 @@ }, "type": "object" }, + "RangeInfo": { + "description": "RangeInfo contains the range name and the range utilization by this cluster.", + "id": "RangeInfo", + "properties": { + "rangeName": { + "description": "Output only. [Output only] Name of a range.", + "readOnly": true, + "type": "string" + }, + "utilization": { + "description": "Output only. [Output only] The utilization of the range.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", diff --git a/container/v1beta1/container-gen.go b/container/v1beta1/container-gen.go index d73f734a577..44cbccf7d29 100644 --- a/container/v1beta1/container-gen.go +++ b/container/v1beta1/container-gen.go @@ -335,11 +335,15 @@ func (s *AcceleratorConfig) MarshalJSON() ([]byte, error) { // configuration for additional pod secondary ranges supporting the // ClusterUpdate message. type AdditionalPodRangesConfig struct { + // PodRangeInfo: Output only. [Output only] Information for additional + // pod range. + PodRangeInfo []*RangeInfo `json:"podRangeInfo,omitempty"` + // PodRangeNames: Name for pod secondary ipv4 range which has the actual // range defined ahead. PodRangeNames []string `json:"podRangeNames,omitempty"` - // ForceSendFields is a list of field names (e.g. "PodRangeNames") to + // ForceSendFields is a list of field names (e.g. "PodRangeInfo") 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 @@ -347,7 +351,7 @@ type AdditionalPodRangesConfig struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "PodRangeNames") to include + // NullFields is a list of field names (e.g. "PodRangeInfo") 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 @@ -670,6 +674,10 @@ type AutoprovisioningNodePoolDefaults struct { // for available image types. ImageType string `json:"imageType,omitempty"` + // InsecureKubeletReadonlyPortEnabled: Enable or disable Kubelet read + // only port. + InsecureKubeletReadonlyPortEnabled bool `json:"insecureKubeletReadonlyPortEnabled,omitempty"` + // Management: NodeManagement configuration for this NodePool. Management *NodeManagement `json:"management,omitempty"` @@ -1631,6 +1639,42 @@ func (s *ClusterAutoscaling) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ClusterNetworkPerformanceConfig: Configuration of all network +// bandwidth tiers +type ClusterNetworkPerformanceConfig struct { + // TotalEgressBandwidthTier: Specifies the total network bandwidth tier + // for the NodePool. + // + // Possible values: + // "TIER_UNSPECIFIED" - Default value + // "TIER_1" - Higher bandwidth, actual values based on VM size. + TotalEgressBandwidthTier string `json:"totalEgressBandwidthTier,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "TotalEgressBandwidthTier") 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. "TotalEgressBandwidthTier") + // 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 *ClusterNetworkPerformanceConfig) MarshalJSON() ([]byte, error) { + type NoMethod ClusterNetworkPerformanceConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ClusterTelemetry: Telemetry integration for the cluster. type ClusterTelemetry struct { // Type: Type of the integration. @@ -1819,6 +1863,10 @@ type ClusterUpdate struct { // versions. DesiredMonitoringService string `json:"desiredMonitoringService,omitempty"` + // DesiredNetworkPerformanceConfig: The desired network performance + // config. + DesiredNetworkPerformanceConfig *ClusterNetworkPerformanceConfig `json:"desiredNetworkPerformanceConfig,omitempty"` + // DesiredNodePoolAutoConfigNetworkTags: The desired network tags that // apply to all auto-provisioned node pools in autopilot clusters and // node auto-provisioning enabled clusters. @@ -2245,6 +2293,7 @@ type DNSConfig struct { // "PLATFORM_DEFAULT" - Use GKE default DNS provider(kube-dns) for DNS // resolution. // "CLOUD_DNS" - Use CloudDNS for DNS resolution. + // "KUBE_DNS" - Use KubeDNS for DNS resolution ClusterDns string `json:"clusterDns,omitempty"` // ClusterDnsDomain: cluster_dns_domain is the suffix used for all @@ -3184,6 +3233,12 @@ type IPAllocationPolicy struct { // `use_ip_aliases` is true. CreateSubnetwork bool `json:"createSubnetwork,omitempty"` + // DefaultPodIpv4RangeUtilization: Output only. [Output only] The + // utilization of the cluster default IPv4 range for pod. The ratio is + // Usage/[Total number of IPs in the secondary range], + // Usage=numNodes*numZones*podIPsPerNode. + DefaultPodIpv4RangeUtilization float64 `json:"defaultPodIpv4RangeUtilization,omitempty"` + // Ipv6AccessType: The ipv6 access type (internal or external) when // create_subnetwork is true // @@ -3316,6 +3371,20 @@ func (s *IPAllocationPolicy) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +func (s *IPAllocationPolicy) UnmarshalJSON(data []byte) error { + type NoMethod IPAllocationPolicy + var s1 struct { + DefaultPodIpv4RangeUtilization gensupport.JSONFloat64 `json:"defaultPodIpv4RangeUtilization"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.DefaultPodIpv4RangeUtilization = float64(s1.DefaultPodIpv4RangeUtilization) + return nil +} + // IdentityServiceConfig: IdentityServiceConfig is configuration for // Identity Service which allows customers to use external identity // providers with the K8S API @@ -4493,6 +4562,9 @@ type NetworkConfig struct { // projects/my-project/global/networks/my-network Network string `json:"network,omitempty"` + // NetworkPerformanceConfig: Network bandwidth tier configuration. + NetworkPerformanceConfig *ClusterNetworkPerformanceConfig `json:"networkPerformanceConfig,omitempty"` + // PrivateIpv6GoogleAccess: The desired state of IPv6 connectivity to // Google Services. By default, no private IPv6 access to or from Google // Services (all access will be via IPv4) @@ -4866,7 +4938,7 @@ type NodeConfig struct { // Preemptible: Whether the nodes are created as preemptible VM // instances. See: // https://cloud.google.com/compute/docs/instances/preemptible for more - // inforamtion about preemptible VM instances. + // information about preemptible VM instances. Preemptible bool `json:"preemptible,omitempty"` // ReservationAffinity: The optional reservation affinity. Setting this @@ -5002,6 +5074,10 @@ type NodeKubeletConfig struct { // unspecified. CpuManagerPolicy string `json:"cpuManagerPolicy,omitempty"` + // InsecureKubeletReadonlyPortEnabled: Enable or disable Kubelet read + // only port. + InsecureKubeletReadonlyPortEnabled bool `json:"insecureKubeletReadonlyPortEnabled,omitempty"` + // PodPidsLimit: Set the Pod PID limits. See // https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits // Controls the maximum number of processes allowed to run in a pod. The @@ -5135,6 +5211,11 @@ type NodeNetworkConfig struct { // field cannot be changed after the node pool has been created. PodIpv4CidrBlock string `json:"podIpv4CidrBlock,omitempty"` + // PodIpv4RangeUtilization: Output only. [Output only] The utilization + // of the IPv4 range for pod. The ratio is Usage/[Total number of IPs in + // the secondary range], Usage=numNodes*numZones*podIPsPerNode. + PodIpv4RangeUtilization float64 `json:"podIpv4RangeUtilization,omitempty"` + // PodRange: The ID of the secondary range for pod IPs. If // `create_pod_range` is true, this ID is used for the new range. If // `create_pod_range` is false, uses an existing secondary range with @@ -5167,6 +5248,20 @@ func (s *NodeNetworkConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +func (s *NodeNetworkConfig) UnmarshalJSON(data []byte) error { + type NoMethod NodeNetworkConfig + var s1 struct { + PodIpv4RangeUtilization gensupport.JSONFloat64 `json:"podIpv4RangeUtilization"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.PodIpv4RangeUtilization = float64(s1.PodIpv4RangeUtilization) + return nil +} + // NodePool: NodePool contains the name and configuration for a // cluster's node pool. Node pools are a set of nodes (i.e. VM's), with // a common configuration and specification, under the control of the @@ -5823,6 +5918,10 @@ func (s *OperationProgress) MarshalJSON() ([]byte, error) { // PlacementPolicy: PlacementPolicy defines the placement policy used by // the node pool. type PlacementPolicy struct { + // TpuTopology: TPU placement topology for pod slice node pool. + // https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies + TpuTopology string `json:"tpuTopology,omitempty"` + // Type: The type of placement. // // Possible values: @@ -5832,7 +5931,7 @@ type PlacementPolicy struct { // availability domain to ensure low communication latency. Type string `json:"type,omitempty"` - // ForceSendFields is a list of field names (e.g. "Type") to + // ForceSendFields is a list of field names (e.g. "TpuTopology") 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 @@ -5840,10 +5939,10 @@ type PlacementPolicy struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Type") 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. "TpuTopology") 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:"-"` @@ -6087,6 +6186,52 @@ func (s *PubSub) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// RangeInfo: RangeInfo contains the range name and the range +// utilization by this cluster. +type RangeInfo struct { + // RangeName: Output only. [Output only] Name of a range. + RangeName string `json:"rangeName,omitempty"` + + // Utilization: Output only. [Output only] The utilization of the range. + Utilization float64 `json:"utilization,omitempty"` + + // ForceSendFields is a list of field names (e.g. "RangeName") 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. "RangeName") 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 *RangeInfo) MarshalJSON() ([]byte, error) { + type NoMethod RangeInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *RangeInfo) UnmarshalJSON(data []byte) error { + type NoMethod RangeInfo + var s1 struct { + Utilization gensupport.JSONFloat64 `json:"utilization"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Utilization = float64(s1.Utilization) + return nil +} + // RecurringTimeWindow: Represents an arbitrary window of time that // recurs. type RecurringTimeWindow struct { diff --git a/content/v2.1/content-api.json b/content/v2.1/content-api.json index 9cc952d6bc6..b7e0a692320 100644 --- a/content/v2.1/content-api.json +++ b/content/v2.1/content-api.json @@ -6271,7 +6271,7 @@ } } }, - "revision": "20230613", + "revision": "20230627", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -13396,6 +13396,13 @@ "description": "URL for the canonical version of your item's landing page.", "type": "string" }, + "certifications": { + "description": "Product [certification](https://support.google.com/merchants/answer/13528839), introduced for EU energy efficiency labeling compliance using the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database.", + "items": { + "$ref": "ProductCertification" + }, + "type": "array" + }, "channel": { "description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" ", "type": "string" @@ -13800,6 +13807,25 @@ }, "type": "object" }, + "ProductCertification": { + "description": "Product [certification](https://support.google.com/merchants/answer/13528839), introduced for EU energy efficiency labeling compliance using the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database.", + "id": "ProductCertification", + "properties": { + "certificationAuthority": { + "description": "The certification authority, for example \"European_Commission\". Maximum length is 2000 characters.", + "type": "string" + }, + "certificationCode": { + "description": "The certification code, for eaxample \"123456\". Maximum length is 2000 characters.", + "type": "string" + }, + "certificationName": { + "description": "The name of the certification, for example \"EPREL\". Maximum length is 2000 characters.", + "type": "string" + } + }, + "type": "object" + }, "ProductCluster": { "description": "Product cluster fields. A product cluster is a grouping for different offers that represent the same product. Values are only set for fields requested explicitly in the request's search query.", "id": "ProductCluster", @@ -16946,6 +16972,10 @@ "$ref": "ServiceStoreConfigCutoffConfigLocalCutoffTime", "description": "Time in hours and minutes in the local timezone when local delivery ends." }, + "noDeliveryPostCutoff": { + "description": "Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.", + "type": "boolean" + }, "storeCloseOffsetHours": { "description": "Represents cutoff time as the number of hours before store closing. Mutually exclusive with other fields (hour and minute).", "format": "int64", diff --git a/content/v2.1/content-gen.go b/content/v2.1/content-gen.go index 706f8145ce7..22ff208a5f7 100644 --- a/content/v2.1/content-gen.go +++ b/content/v2.1/content-gen.go @@ -12928,6 +12928,12 @@ type Product struct { // page. CanonicalLink string `json:"canonicalLink,omitempty"` + // Certifications: Product certification + // (https://support.google.com/merchants/answer/13528839), introduced + // for EU energy efficiency labeling compliance using the EU EPREL + // (https://eprel.ec.europa.eu/screen/home) database. + Certifications []*ProductCertification `json:"certifications,omitempty"` + // Channel: Required. The item's channel (online or local). Acceptable // values are: - "local" - "online" Channel string `json:"channel,omitempty"` @@ -13346,6 +13352,48 @@ func (s *ProductAmount) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ProductCertification: Product certification +// (https://support.google.com/merchants/answer/13528839), introduced +// for EU energy efficiency labeling compliance using the EU EPREL +// (https://eprel.ec.europa.eu/screen/home) database. +type ProductCertification struct { + // CertificationAuthority: The certification authority, for example + // "European_Commission". Maximum length is 2000 characters. + CertificationAuthority string `json:"certificationAuthority,omitempty"` + + // CertificationCode: The certification code, for eaxample "123456". + // Maximum length is 2000 characters. + CertificationCode string `json:"certificationCode,omitempty"` + + // CertificationName: The name of the certification, for example + // "EPREL". Maximum length is 2000 characters. + CertificationName string `json:"certificationName,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "CertificationAuthority") 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. "CertificationAuthority") + // 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 *ProductCertification) MarshalJSON() ([]byte, error) { + type NoMethod ProductCertification + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ProductCluster: Product cluster fields. A product cluster is a // grouping for different offers that represent the same product. Values // are only set for fields requested explicitly in the request's search @@ -18276,6 +18324,16 @@ type ServiceStoreConfigCutoffConfig struct { // local delivery ends. LocalCutoffTime *ServiceStoreConfigCutoffConfigLocalCutoffTime `json:"localCutoffTime,omitempty"` + // NoDeliveryPostCutoff: Merchants can opt-out of showing n+1 day local + // delivery when they have a shipping service configured to n day local + // delivery. For example, if the shipping service defines same-day + // delivery, and it's past the cut-off, setting this field to `true` + // results in the calculated shipping service rate returning + // `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to + // `false` results in the calculated shipping time being one day. This + // is only for local delivery. + NoDeliveryPostCutoff bool `json:"noDeliveryPostCutoff,omitempty"` + // StoreCloseOffsetHours: Represents cutoff time as the number of hours // before store closing. Mutually exclusive with other fields (hour and // minute). diff --git a/essentialcontacts/v1/essentialcontacts-api.json b/essentialcontacts/v1/essentialcontacts-api.json index 067955a3bfa..135ca3cf200 100644 --- a/essentialcontacts/v1/essentialcontacts-api.json +++ b/essentialcontacts/v1/essentialcontacts-api.json @@ -1,4 +1,13 @@ { + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, "basePath": "", "baseUrl": "https://essentialcontacts.googleapis.com/", "batchPath": "batch", @@ -159,7 +168,10 @@ "path": "v1/{+parent}/contacts:compute", "response": { "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "create": { "description": "Adds a new contact for a resource.", @@ -184,7 +196,10 @@ }, "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "delete": { "description": "Deletes a contact.", @@ -206,7 +221,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { "description": "Gets a single contact.", @@ -228,7 +246,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { "description": "Lists the contacts that have been set on a resource.", @@ -261,7 +282,10 @@ "path": "v1/{+parent}/contacts", "response": { "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "patch": { "description": "Updates a contact. Note: A contact's email address cannot be changed.", @@ -292,7 +316,10 @@ }, "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "sendTestMessage": { "description": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", @@ -317,7 +344,10 @@ }, "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -386,7 +416,10 @@ "path": "v1/{+parent}/contacts:compute", "response": { "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "create": { "description": "Adds a new contact for a resource.", @@ -411,7 +444,10 @@ }, "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "delete": { "description": "Deletes a contact.", @@ -433,7 +469,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { "description": "Gets a single contact.", @@ -455,7 +494,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { "description": "Lists the contacts that have been set on a resource.", @@ -488,7 +530,10 @@ "path": "v1/{+parent}/contacts", "response": { "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "patch": { "description": "Updates a contact. Note: A contact's email address cannot be changed.", @@ -519,7 +564,10 @@ }, "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "sendTestMessage": { "description": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", @@ -544,7 +592,10 @@ }, "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -613,7 +664,10 @@ "path": "v1/{+parent}/contacts:compute", "response": { "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "create": { "description": "Adds a new contact for a resource.", @@ -638,7 +692,10 @@ }, "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "delete": { "description": "Deletes a contact.", @@ -660,7 +717,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { "description": "Gets a single contact.", @@ -682,7 +742,10 @@ "path": "v1/{+name}", "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { "description": "Lists the contacts that have been set on a resource.", @@ -715,7 +778,10 @@ "path": "v1/{+parent}/contacts", "response": { "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "patch": { "description": "Updates a contact. Note: A contact's email address cannot be changed.", @@ -746,7 +812,10 @@ }, "response": { "$ref": "GoogleCloudEssentialcontactsV1Contact" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "sendTestMessage": { "description": "Allows a contact admin to send a test message to contact to verify that it has been configured correctly.", @@ -771,14 +840,17 @@ }, "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } } }, - "revision": "20230618", + "revision": "20230628", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/essentialcontacts/v1/essentialcontacts-gen.go b/essentialcontacts/v1/essentialcontacts-gen.go index 1fa6d007dfe..88c45cb593e 100644 --- a/essentialcontacts/v1/essentialcontacts-gen.go +++ b/essentialcontacts/v1/essentialcontacts-gen.go @@ -79,8 +79,20 @@ const apiVersion = "v1" const basePath = "https://essentialcontacts.googleapis.com/" const mtlsBasePath = "https://essentialcontacts.mtls.googleapis.com/" +// OAuth2 scopes used by this API. +const ( + // See, edit, configure, and delete your Google Cloud data and see the + // email address for your Google Account. + CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" +) + // NewService creates a new Service. func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { + scopesOption := internaloption.WithDefaultScopes( + "https://www.googleapis.com/auth/cloud-platform", + ) + // NOTE: prepend, so we don't override user-specified scopes. + opts = append([]option.ClientOption{scopesOption}, opts...) opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) client, endpoint, err := htransport.NewClient(ctx, opts...) @@ -685,7 +697,10 @@ func (c *FoldersContactsComputeCall) Do(opts ...googleapi.CallOption) (*GoogleCl // "path": "v1/{+parent}/contacts:compute", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -848,7 +863,10 @@ func (c *FoldersContactsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleClo // }, // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -980,7 +998,10 @@ func (c *FoldersContactsDeleteCall) Do(opts ...googleapi.CallOption) (*GooglePro // "path": "v1/{+name}", // "response": { // "$ref": "GoogleProtobufEmpty" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -1127,7 +1148,10 @@ func (c *FoldersContactsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudE // "path": "v1/{+name}", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -1305,7 +1329,10 @@ func (c *FoldersContactsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloud // "path": "v1/{+parent}/contacts", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -1482,7 +1509,10 @@ func (c *FoldersContactsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleClou // }, // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -1626,7 +1656,10 @@ func (c *FoldersContactsSendTestMessageCall) Do(opts ...googleapi.CallOption) (* // }, // "response": { // "$ref": "GoogleProtobufEmpty" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -1882,7 +1915,10 @@ func (c *OrganizationsContactsComputeCall) Do(opts ...googleapi.CallOption) (*Go // "path": "v1/{+parent}/contacts:compute", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -2045,7 +2081,10 @@ func (c *OrganizationsContactsCreateCall) Do(opts ...googleapi.CallOption) (*Goo // }, // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -2177,7 +2216,10 @@ func (c *OrganizationsContactsDeleteCall) Do(opts ...googleapi.CallOption) (*Goo // "path": "v1/{+name}", // "response": { // "$ref": "GoogleProtobufEmpty" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -2324,7 +2366,10 @@ func (c *OrganizationsContactsGetCall) Do(opts ...googleapi.CallOption) (*Google // "path": "v1/{+name}", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -2502,7 +2547,10 @@ func (c *OrganizationsContactsListCall) Do(opts ...googleapi.CallOption) (*Googl // "path": "v1/{+parent}/contacts", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -2679,7 +2727,10 @@ func (c *OrganizationsContactsPatchCall) Do(opts ...googleapi.CallOption) (*Goog // }, // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -2823,7 +2874,10 @@ func (c *OrganizationsContactsSendTestMessageCall) Do(opts ...googleapi.CallOpti // }, // "response": { // "$ref": "GoogleProtobufEmpty" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -3079,7 +3133,10 @@ func (c *ProjectsContactsComputeCall) Do(opts ...googleapi.CallOption) (*GoogleC // "path": "v1/{+parent}/contacts:compute", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1ComputeContactsResponse" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -3242,7 +3299,10 @@ func (c *ProjectsContactsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCl // }, // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -3374,7 +3434,10 @@ func (c *ProjectsContactsDeleteCall) Do(opts ...googleapi.CallOption) (*GooglePr // "path": "v1/{+name}", // "response": { // "$ref": "GoogleProtobufEmpty" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -3521,7 +3584,10 @@ func (c *ProjectsContactsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloud // "path": "v1/{+name}", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -3699,7 +3765,10 @@ func (c *ProjectsContactsListCall) Do(opts ...googleapi.CallOption) (*GoogleClou // "path": "v1/{+parent}/contacts", // "response": { // "$ref": "GoogleCloudEssentialcontactsV1ListContactsResponse" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -3876,7 +3945,10 @@ func (c *ProjectsContactsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleClo // }, // "response": { // "$ref": "GoogleCloudEssentialcontactsV1Contact" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } @@ -4020,7 +4092,10 @@ func (c *ProjectsContactsSendTestMessageCall) Do(opts ...googleapi.CallOption) ( // }, // "response": { // "$ref": "GoogleProtobufEmpty" - // } + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] // } } diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json index 38af7b19b3f..62204b156ee 100644 --- a/pubsub/v1/pubsub-api.json +++ b/pubsub/v1/pubsub-api.json @@ -681,13 +681,13 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of snapshots to return.", + "description": "Optional. Maximum number of snapshots to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -718,7 +718,7 @@ ], "parameters": { "name": { - "description": "The name of the snapshot.", + "description": "Optional. The name of the snapshot.", "location": "path", "pattern": "^projects/[^/]+/snapshots/[^/]+$", "required": true, @@ -977,13 +977,13 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of subscriptions to return.", + "description": "Optional. Maximum number of subscriptions to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1334,13 +1334,13 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of topics to return.", + "description": "Optional. Maximum number of topics to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1491,13 +1491,13 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of snapshot names to return.", + "description": "Optional. Maximum number of snapshot names to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1532,13 +1532,13 @@ ], "parameters": { "pageSize": { - "description": "Maximum number of subscription names to return.", + "description": "Optional. Maximum number of subscription names to return.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1566,7 +1566,7 @@ } } }, - "revision": "20230529", + "revision": "20230620", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1588,7 +1588,7 @@ "id": "AvroConfig", "properties": { "writeMetadata": { - "description": "When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output.", + "description": "Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output.", "type": "boolean" } }, @@ -1599,7 +1599,7 @@ "id": "BigQueryConfig", "properties": { "dropUnknownFields": { - "description": "When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.", + "description": "Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.", "type": "boolean" }, "state": { @@ -1622,15 +1622,15 @@ "type": "string" }, "table": { - "description": "The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}", + "description": "Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}", "type": "string" }, "useTopicSchema": { - "description": "When true, use the topic's schema as the columns to write to in BigQuery, if it exists.", + "description": "Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.", "type": "boolean" }, "writeMetadata": { - "description": "When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.", + "description": "Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.", "type": "boolean" } }, @@ -1664,27 +1664,27 @@ "properties": { "avroConfig": { "$ref": "AvroConfig", - "description": "If set, message data will be written to Cloud Storage in Avro format." + "description": "Optional. If set, message data will be written to Cloud Storage in Avro format." }, "bucket": { "description": "Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like \"gs://\". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).", "type": "string" }, "filenamePrefix": { - "description": "User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).", + "description": "Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).", "type": "string" }, "filenameSuffix": { - "description": "User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).", + "description": "Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).", "type": "string" }, "maxBytes": { - "description": "The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.", + "description": "Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.", "format": "int64", "type": "string" }, "maxDuration": { - "description": "The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.", + "description": "Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.", "format": "google-duration", "type": "string" }, @@ -1707,7 +1707,7 @@ }, "textConfig": { "$ref": "TextConfig", - "description": "If set, message data will be written to Cloud Storage in text format." + "description": "Optional. If set, message data will be written to Cloud Storage in text format." } }, "type": "object" @@ -1731,7 +1731,7 @@ "additionalProperties": { "type": "string" }, - "description": "See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).", + "description": "Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).", "type": "object" }, "subscription": { @@ -1746,11 +1746,11 @@ "id": "DeadLetterPolicy", "properties": { "deadLetterTopic": { - "description": "The name of the topic to which dead letter messages should be published. Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.", + "description": "Optional. The name of the topic to which dead letter messages should be published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.", "type": "string" }, "maxDeliveryAttempts": { - "description": "The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", + "description": "Optional. The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.", "format": "int32", "type": "integer" } @@ -1774,7 +1774,7 @@ "id": "ExpirationPolicy", "properties": { "ttl": { - "description": "Specifies the \"time-to-live\" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of \"activity\" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires.", + "description": "Optional. Specifies the \"time-to-live\" duration for an associated resource. The resource expires if it is not active for a period of `ttl`. The definition of \"activity\" depends on the type of the associated resource. The minimum and maximum allowed values for `ttl` depend on the type of the associated resource, as well. If `ttl` is not set, the associated resource never expires.", "format": "google-duration", "type": "string" } @@ -1845,11 +1845,11 @@ "id": "ListSnapshotsResponse", "properties": { "nextPageToken": { - "description": "If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`.", + "description": "Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`.", "type": "string" }, "snapshots": { - "description": "The resulting snapshots.", + "description": "Optional. The resulting snapshots.", "items": { "$ref": "Snapshot" }, @@ -1863,11 +1863,11 @@ "id": "ListSubscriptionsResponse", "properties": { "nextPageToken": { - "description": "If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.", + "description": "Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.", "type": "string" }, "subscriptions": { - "description": "The subscriptions that match the request.", + "description": "Optional. The subscriptions that match the request.", "items": { "$ref": "Subscription" }, @@ -1881,11 +1881,11 @@ "id": "ListTopicSnapshotsResponse", "properties": { "nextPageToken": { - "description": "If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots.", + "description": "Optional. If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new `ListTopicSnapshotsRequest` to get more snapshots.", "type": "string" }, "snapshots": { - "description": "The names of the snapshots that match the request.", + "description": "Optional. The names of the snapshots that match the request.", "items": { "type": "string" }, @@ -1899,11 +1899,11 @@ "id": "ListTopicSubscriptionsResponse", "properties": { "nextPageToken": { - "description": "If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.", + "description": "Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.", "type": "string" }, "subscriptions": { - "description": "The names of subscriptions attached to the topic specified in the request.", + "description": "Optional. The names of subscriptions attached to the topic specified in the request.", "items": { "type": "string" }, @@ -1917,11 +1917,11 @@ "id": "ListTopicsResponse", "properties": { "nextPageToken": { - "description": "If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.", + "description": "Optional. If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.", "type": "string" }, "topics": { - "description": "The resulting topics.", + "description": "Optional. The resulting topics.", "items": { "$ref": "Topic" }, @@ -1935,7 +1935,7 @@ "id": "MessageStoragePolicy", "properties": { "allowedPersistenceRegions": { - "description": "A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.", + "description": "Optional. A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.", "items": { "type": "string" }, @@ -1979,7 +1979,7 @@ "id": "NoWrapper", "properties": { "writeMetadata": { - "description": "When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:` headers of the HTTP request. Writes the Pub/Sub message attributes to `:` headers of the HTTP request.", + "description": "Optional. When true, writes the Pub/Sub message metadata to `x-goog-pubsub-:` headers of the HTTP request. Writes the Pub/Sub message attributes to `:` headers of the HTTP request.", "type": "boolean" } }, @@ -1990,11 +1990,11 @@ "id": "OidcToken", "properties": { "audience": { - "description": "Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.", + "description": "Optional. Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.", "type": "string" }, "serviceAccountEmail": { - "description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).", + "description": "Optional. [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for generating the OIDC token. For more information on setting up authentication, see [Push subscriptions](https://cloud.google.com/pubsub/docs/push).", "type": "string" } }, @@ -2043,7 +2043,7 @@ "id": "PublishResponse", "properties": { "messageIds": { - "description": "The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.", + "description": "Optional. The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.", "items": { "type": "string" }, @@ -2060,24 +2060,24 @@ "additionalProperties": { "type": "string" }, - "description": "Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.", + "description": "Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.", "type": "object" }, "data": { - "description": "The message data field. If this field is empty, the message must contain at least one attribute.", + "description": "Optional. The message data field. If this field is empty, the message must contain at least one attribute.", "format": "byte", "type": "string" }, "messageId": { - "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", + "description": "Optional. ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", "type": "string" }, "orderingKey": { - "description": "If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).", + "description": "Optional. If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).", "type": "string" }, "publishTime": { - "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", + "description": "Optional. The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", "format": "google-datetime", "type": "string" } @@ -2111,7 +2111,7 @@ "id": "PullResponse", "properties": { "receivedMessages": { - "description": "Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog, or if no messages could be returned before the request timeout. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.", + "description": "Optional. Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog, or if no messages could be returned before the request timeout. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.", "items": { "$ref": "ReceivedMessage" }, @@ -2128,23 +2128,23 @@ "additionalProperties": { "type": "string" }, - "description": "Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { \"x-goog-version\": \"v1\" }`", + "description": "Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { \"x-goog-version\": \"v1\" }`", "type": "object" }, "noWrapper": { "$ref": "NoWrapper", - "description": "When set, the payload to the push endpoint is not wrapped." + "description": "Optional. When set, the payload to the push endpoint is not wrapped." }, "oidcToken": { "$ref": "OidcToken", - "description": "If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message." + "description": "Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message." }, "pubsubWrapper": { "$ref": "PubsubWrapper", - "description": "When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage)." + "description": "Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage)." }, "pushEndpoint": { - "description": "A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`.", + "description": "Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`.", "type": "string" } }, @@ -2155,32 +2155,32 @@ "id": "ReceivedMessage", "properties": { "ackId": { - "description": "This ID can be used to acknowledge the received message.", + "description": "Optional. This ID can be used to acknowledge the received message.", "type": "string" }, "deliveryAttempt": { - "description": "The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. Upon the first delivery of a given message, `delivery_attempt` will have a value of 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0.", + "description": "Optional. The approximate number of times that Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. Upon the first delivery of a given message, `delivery_attempt` will have a value of 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0.", "format": "int32", "type": "integer" }, "message": { "$ref": "PubsubMessage", - "description": "The message." + "description": "Optional. The message." } }, "type": "object" }, "RetryPolicy": { - "description": "A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", + "description": "A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.", "id": "RetryPolicy", "properties": { "maximumBackoff": { - "description": "The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.", + "description": "Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.", "format": "google-duration", "type": "string" }, "minimumBackoff": { - "description": "The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.", + "description": "Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.", "format": "google-duration", "type": "string" } @@ -2243,7 +2243,7 @@ "id": "SchemaSettings", "properties": { "encoding": { - "description": "The encoding of messages validated against `schema`.", + "description": "Optional. The encoding of messages validated against `schema`.", "enum": [ "ENCODING_UNSPECIFIED", "JSON", @@ -2257,11 +2257,11 @@ "type": "string" }, "firstRevisionId": { - "description": "The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.", + "description": "Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.", "type": "string" }, "lastRevisionId": { - "description": "The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.", + "description": "Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.", "type": "string" }, "schema": { @@ -2276,11 +2276,11 @@ "id": "SeekRequest", "properties": { "snapshot": { - "description": "The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is `projects/{project}/snapshots/{snap}`.", + "description": "Optional. The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is `projects/{project}/snapshots/{snap}`.", "type": "string" }, "time": { - "description": "The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of `message_retention_duration` and `retain_acked_messages`). For example, if `time` corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.", + "description": "Optional. The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of `message_retention_duration` and `retain_acked_messages`). For example, if `time` corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.", "format": "google-datetime", "type": "string" } @@ -2309,7 +2309,7 @@ "id": "Snapshot", "properties": { "expireTime": { - "description": "The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.", + "description": "Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.", "format": "google-datetime", "type": "string" }, @@ -2317,15 +2317,15 @@ "additionalProperties": { "type": "string" }, - "description": "See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).", + "description": "Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).", "type": "object" }, "name": { - "description": "The name of the snapshot.", + "description": "Optional. The name of the snapshot.", "type": "string" }, "topic": { - "description": "The name of the topic from which this snapshot is retaining messages.", + "description": "Optional. The name of the topic from which this snapshot is retaining messages.", "type": "string" } }, @@ -2336,51 +2336,51 @@ "id": "Subscription", "properties": { "ackDeadlineSeconds": { - "description": "The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.", + "description": "Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.", "format": "int32", "type": "integer" }, "bigqueryConfig": { "$ref": "BigQueryConfig", - "description": "If delivery to BigQuery is used with this subscription, this field is used to configure it." + "description": "Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it." }, "cloudStorageConfig": { "$ref": "CloudStorageConfig", - "description": "If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it." + "description": "Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it." }, "deadLetterPolicy": { "$ref": "DeadLetterPolicy", - "description": "A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription." + "description": "Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription." }, "detached": { - "description": "Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.", + "description": "Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.", "type": "boolean" }, "enableExactlyOnceDelivery": { - "description": "If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", + "description": "Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values.", "type": "boolean" }, "enableMessageOrdering": { - "description": "If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.", + "description": "Optional. If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.", "type": "boolean" }, "expirationPolicy": { "$ref": "ExpirationPolicy", - "description": "A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires." + "description": "Optional. A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but `expiration_policy.ttl` is not set, the subscription never expires." }, "filter": { - "description": "An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.", + "description": "Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).", + "description": "Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).", "type": "object" }, "messageRetentionDuration": { - "description": "How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.", + "description": "Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.", "format": "google-duration", "type": "string" }, @@ -2390,15 +2390,15 @@ }, "pushConfig": { "$ref": "PushConfig", - "description": "If push delivery is used with this subscription, this field is used to configure it." + "description": "Optional. If push delivery is used with this subscription, this field is used to configure it." }, "retainAckedMessages": { - "description": "Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.", + "description": "Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.", "type": "boolean" }, "retryPolicy": { "$ref": "RetryPolicy", - "description": "A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." + "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." }, "state": { "description": "Output only. An output-only field indicating whether or not the subscription can receive messages.", @@ -2467,36 +2467,36 @@ "id": "Topic", "properties": { "kmsKeyName": { - "description": "The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", + "description": "Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).", + "description": "Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).", "type": "object" }, "messageRetentionDuration": { - "description": "Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.", + "description": "Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.", "format": "google-duration", "type": "string" }, "messageStoragePolicy": { "$ref": "MessageStoragePolicy", - "description": "Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect." + "description": "Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect." }, "name": { "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" }, "satisfiesPzs": { - "description": "Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.", + "description": "Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.", "type": "boolean" }, "schemaSettings": { "$ref": "SchemaSettings", - "description": "Settings for validating messages published against a schema." + "description": "Optional. Settings for validating messages published against a schema." } }, "type": "object" diff --git a/pubsub/v1/pubsub-gen.go b/pubsub/v1/pubsub-gen.go index 6646dbf88f5..a0bc0b01132 100644 --- a/pubsub/v1/pubsub-gen.go +++ b/pubsub/v1/pubsub-gen.go @@ -263,9 +263,9 @@ func (s *AcknowledgeRequest) MarshalJSON() ([]byte, error) { // Message payloads and metadata will be written to files as an Avro // binary. type AvroConfig struct { - // WriteMetadata: When true, write the subscription name, message_id, - // publish_time, attributes, and ordering_key as additional fields in - // the output. + // WriteMetadata: Optional. When true, write the subscription name, + // message_id, publish_time, attributes, and ordering_key as additional + // fields in the output. WriteMetadata bool `json:"writeMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "WriteMetadata") to @@ -293,11 +293,12 @@ func (s *AvroConfig) MarshalJSON() ([]byte, error) { // BigQueryConfig: Configuration for a BigQuery subscription. type BigQueryConfig struct { - // DropUnknownFields: When true and use_topic_schema is true, any fields - // that are a part of the topic schema that are not part of the BigQuery - // table schema are dropped when writing to BigQuery. Otherwise, the - // schemas must be kept in sync and any messages with extra fields are - // not written and remain in the subscription's backlog. + // DropUnknownFields: Optional. When true and use_topic_schema is true, + // any fields that are a part of the topic schema that are not part of + // the BigQuery table schema are dropped when writing to BigQuery. + // Otherwise, the schemas must be kept in sync and any messages with + // extra fields are not written and remain in the subscription's + // backlog. DropUnknownFields bool `json:"dropUnknownFields,omitempty"` // State: Output only. An output-only field that indicates whether or @@ -320,20 +321,20 @@ type BigQueryConfig struct { // schema mismatch. State string `json:"state,omitempty"` - // Table: The name of the table to which to write data, of the form - // {projectId}.{datasetId}.{tableId} + // Table: Optional. The name of the table to which to write data, of the + // form {projectId}.{datasetId}.{tableId} Table string `json:"table,omitempty"` - // UseTopicSchema: When true, use the topic's schema as the columns to - // write to in BigQuery, if it exists. + // UseTopicSchema: Optional. When true, use the topic's schema as the + // columns to write to in BigQuery, if it exists. UseTopicSchema bool `json:"useTopicSchema,omitempty"` - // WriteMetadata: When true, write the subscription name, message_id, - // publish_time, attributes, and ordering_key to additional columns in - // the table. The subscription name, message_id, and publish_time fields - // are put in their own columns while all other message properties - // (other than data) are written to a JSON object in the attributes - // column. + // WriteMetadata: Optional. When true, write the subscription name, + // message_id, publish_time, attributes, and ordering_key to additional + // columns in the table. The subscription name, message_id, and + // publish_time fields are put in their own columns while all other + // message properties (other than data) are written to a JSON object in + // the attributes column. WriteMetadata bool `json:"writeMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "DropUnknownFields") @@ -440,8 +441,8 @@ func (s *Binding) MarshalJSON() ([]byte, error) { // CloudStorageConfig: Configuration for a Cloud Storage subscription. type CloudStorageConfig struct { - // AvroConfig: If set, message data will be written to Cloud Storage in - // Avro format. + // AvroConfig: Optional. If set, message data will be written to Cloud + // Storage in Avro format. AvroConfig *AvroConfig `json:"avroConfig,omitempty"` // Bucket: Required. User-provided name for the Cloud Storage bucket. @@ -450,25 +451,26 @@ type CloudStorageConfig struct { // (https://cloud.google.com/storage/docs/buckets#naming). Bucket string `json:"bucket,omitempty"` - // FilenamePrefix: User-provided prefix for Cloud Storage filename. See - // the object naming requirements + // FilenamePrefix: Optional. User-provided prefix for Cloud Storage + // filename. See the object naming requirements // (https://cloud.google.com/storage/docs/objects#naming). FilenamePrefix string `json:"filenamePrefix,omitempty"` - // FilenameSuffix: User-provided suffix for Cloud Storage filename. See - // the object naming requirements + // FilenameSuffix: Optional. User-provided suffix for Cloud Storage + // filename. See the object naming requirements // (https://cloud.google.com/storage/docs/objects#naming). FilenameSuffix string `json:"filenameSuffix,omitempty"` - // MaxBytes: The maximum bytes that can be written to a Cloud Storage - // file before a new file is created. Min 1 KB, max 10 GiB. The + // MaxBytes: Optional. The maximum bytes that can be written to a Cloud + // Storage file before a new file is created. Min 1 KB, max 10 GiB. The // max_bytes limit may be exceeded in cases where messages are larger // than the limit. MaxBytes int64 `json:"maxBytes,omitempty,string"` - // MaxDuration: The maximum duration that can elapse before a new Cloud - // Storage file is created. Min 1 minute, max 10 minutes, default 5 - // minutes. May not exceed the subscription's acknowledgement deadline. + // MaxDuration: Optional. The maximum duration that can elapse before a + // new Cloud Storage file is created. Min 1 minute, max 10 minutes, + // default 5 minutes. May not exceed the subscription's acknowledgement + // deadline. MaxDuration string `json:"maxDuration,omitempty"` // State: Output only. An output-only field that indicates whether or @@ -484,8 +486,8 @@ type CloudStorageConfig struct { // does not exist. State string `json:"state,omitempty"` - // TextConfig: If set, message data will be written to Cloud Storage in - // text format. + // TextConfig: Optional. If set, message data will be written to Cloud + // Storage in text format. TextConfig *TextConfig `json:"textConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "AvroConfig") to @@ -541,7 +543,7 @@ func (s *CommitSchemaRequest) MarshalJSON() ([]byte, error) { // CreateSnapshotRequest: Request for the `CreateSnapshot` method. type CreateSnapshotRequest struct { - // Labels: See Creating and managing labels + // Labels: Optional. See Creating and managing labels // (https://cloud.google.com/pubsub/docs/labels). Labels map[string]string `json:"labels,omitempty"` @@ -583,9 +585,9 @@ func (s *CreateSnapshotRequest) MarshalJSON() ([]byte, error) { // any of the fields fails at subscription creation/updation, the // create/update subscription request will fail. type DeadLetterPolicy struct { - // DeadLetterTopic: The name of the topic to which dead letter messages - // should be published. Format is - // `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service account + // DeadLetterTopic: Optional. The name of the topic to which dead letter + // messages should be published. Format is + // `projects/{project}/topics/{topic}`.The Pub/Sub service account // associated with the enclosing subscription's parent project (i.e., // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must // have permission to Publish() to this topic. The operation will fail @@ -594,14 +596,14 @@ type DeadLetterPolicy struct { // topic with no subscriptions are lost. DeadLetterTopic string `json:"deadLetterTopic,omitempty"` - // MaxDeliveryAttempts: The maximum number of delivery attempts for any - // message. The value must be between 5 and 100. The number of delivery - // attempts is defined as 1 + (the sum of number of NACKs and number of - // times the acknowledgement deadline has been exceeded for the - // message). A NACK is any call to ModifyAckDeadline with a 0 deadline. - // Note that client libraries may automatically extend ack_deadlines. - // This field will be honored on a best effort basis. If this parameter - // is 0, a default value of 5 is used. + // MaxDeliveryAttempts: Optional. The maximum number of delivery + // attempts for any message. The value must be between 5 and 100. The + // number of delivery attempts is defined as 1 + (the sum of number of + // NACKs and number of times the acknowledgement deadline has been + // exceeded for the message). A NACK is any call to ModifyAckDeadline + // with a 0 deadline. Note that client libraries may automatically + // extend ack_deadlines. This field will be honored on a best effort + // basis. If this parameter is 0, a default value of 5 is used. MaxDeliveryAttempts int64 `json:"maxDeliveryAttempts,omitempty"` // ForceSendFields is a list of field names (e.g. "DeadLetterTopic") to @@ -650,12 +652,12 @@ type Empty struct { // ExpirationPolicy: A policy that specifies the conditions for resource // expiration (i.e., automatic resource deletion). type ExpirationPolicy struct { - // Ttl: Specifies the "time-to-live" duration for an associated - // resource. The resource expires if it is not active for a period of - // `ttl`. The definition of "activity" depends on the type of the - // associated resource. The minimum and maximum allowed values for `ttl` - // depend on the type of the associated resource, as well. If `ttl` is - // not set, the associated resource never expires. + // Ttl: Optional. Specifies the "time-to-live" duration for an + // associated resource. The resource expires if it is not active for a + // period of `ttl`. The definition of "activity" depends on the type of + // the associated resource. The minimum and maximum allowed values for + // `ttl` depend on the type of the associated resource, as well. If + // `ttl` is not set, the associated resource never expires. Ttl string `json:"ttl,omitempty"` // ForceSendFields is a list of field names (e.g. "Ttl") to @@ -817,12 +819,12 @@ func (s *ListSchemasResponse) MarshalJSON() ([]byte, error) { // ListSnapshotsResponse: Response for the `ListSnapshots` method. type ListSnapshotsResponse struct { - // NextPageToken: If not empty, indicates that there may be more - // snapshot that match the request; this value should be passed in a new - // `ListSnapshotsRequest`. + // NextPageToken: Optional. If not empty, indicates that there may be + // more snapshot that match the request; this value should be passed in + // a new `ListSnapshotsRequest`. NextPageToken string `json:"nextPageToken,omitempty"` - // Snapshots: The resulting snapshots. + // Snapshots: Optional. The resulting snapshots. Snapshots []*Snapshot `json:"snapshots,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -855,12 +857,12 @@ func (s *ListSnapshotsResponse) MarshalJSON() ([]byte, error) { // ListSubscriptionsResponse: Response for the `ListSubscriptions` // method. type ListSubscriptionsResponse struct { - // NextPageToken: If not empty, indicates that there may be more - // subscriptions that match the request; this value should be passed in - // a new `ListSubscriptionsRequest` to get more subscriptions. + // NextPageToken: Optional. If not empty, indicates that there may be + // more subscriptions that match the request; this value should be + // passed in a new `ListSubscriptionsRequest` to get more subscriptions. NextPageToken string `json:"nextPageToken,omitempty"` - // Subscriptions: The subscriptions that match the request. + // Subscriptions: Optional. The subscriptions that match the request. Subscriptions []*Subscription `json:"subscriptions,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -893,12 +895,13 @@ func (s *ListSubscriptionsResponse) MarshalJSON() ([]byte, error) { // ListTopicSnapshotsResponse: Response for the `ListTopicSnapshots` // method. type ListTopicSnapshotsResponse struct { - // NextPageToken: If not empty, indicates that there may be more - // snapshots that match the request; this value should be passed in a - // new `ListTopicSnapshotsRequest` to get more snapshots. + // NextPageToken: Optional. If not empty, indicates that there may be + // more snapshots that match the request; this value should be passed in + // a new `ListTopicSnapshotsRequest` to get more snapshots. NextPageToken string `json:"nextPageToken,omitempty"` - // Snapshots: The names of the snapshots that match the request. + // Snapshots: Optional. The names of the snapshots that match the + // request. Snapshots []string `json:"snapshots,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -931,13 +934,14 @@ func (s *ListTopicSnapshotsResponse) MarshalJSON() ([]byte, error) { // ListTopicSubscriptionsResponse: Response for the // `ListTopicSubscriptions` method. type ListTopicSubscriptionsResponse struct { - // NextPageToken: If not empty, indicates that there may be more - // subscriptions that match the request; this value should be passed in - // a new `ListTopicSubscriptionsRequest` to get more subscriptions. + // NextPageToken: Optional. If not empty, indicates that there may be + // more subscriptions that match the request; this value should be + // passed in a new `ListTopicSubscriptionsRequest` to get more + // subscriptions. NextPageToken string `json:"nextPageToken,omitempty"` - // Subscriptions: The names of subscriptions attached to the topic - // specified in the request. + // Subscriptions: Optional. The names of subscriptions attached to the + // topic specified in the request. Subscriptions []string `json:"subscriptions,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -969,12 +973,12 @@ func (s *ListTopicSubscriptionsResponse) MarshalJSON() ([]byte, error) { // ListTopicsResponse: Response for the `ListTopics` method. type ListTopicsResponse struct { - // NextPageToken: If not empty, indicates that there may be more topics - // that match the request; this value should be passed in a new - // `ListTopicsRequest`. + // NextPageToken: Optional. If not empty, indicates that there may be + // more topics that match the request; this value should be passed in a + // new `ListTopicsRequest`. NextPageToken string `json:"nextPageToken,omitempty"` - // Topics: The resulting topics. + // Topics: Optional. The resulting topics. Topics []*Topic `json:"topics,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1007,12 +1011,12 @@ func (s *ListTopicsResponse) MarshalJSON() ([]byte, error) { // MessageStoragePolicy: A policy constraining the storage of messages // published to the topic. type MessageStoragePolicy struct { - // AllowedPersistenceRegions: A list of IDs of GCP regions where - // messages that are published to the topic may be persisted in storage. - // Messages published by publishers running in non-allowed GCP regions - // (or running outside of GCP altogether) will be routed for storage in - // one of the allowed regions. An empty list means that no regions are - // allowed, and is not a valid configuration. + // AllowedPersistenceRegions: Optional. A list of IDs of GCP regions + // where messages that are published to the topic may be persisted in + // storage. Messages published by publishers running in non-allowed GCP + // regions (or running outside of GCP altogether) will be routed for + // storage in one of the allowed regions. An empty list means that no + // regions are allowed, and is not a valid configuration. AllowedPersistenceRegions []string `json:"allowedPersistenceRegions,omitempty"` // ForceSendFields is a list of field names (e.g. @@ -1114,9 +1118,9 @@ func (s *ModifyPushConfigRequest) MarshalJSON() ([]byte, error) { // NoWrapper: Sets the `data` field as the HTTP body for delivery. type NoWrapper struct { - // WriteMetadata: When true, writes the Pub/Sub message metadata to - // `x-goog-pubsub-:` headers of the HTTP request. Writes the Pub/Sub - // message attributes to `:` headers of the HTTP request. + // WriteMetadata: Optional. When true, writes the Pub/Sub message + // metadata to `x-goog-pubsub-:` headers of the HTTP request. Writes the + // Pub/Sub message attributes to `:` headers of the HTTP request. WriteMetadata bool `json:"writeMetadata,omitempty"` // ForceSendFields is a list of field names (e.g. "WriteMetadata") to @@ -1146,8 +1150,8 @@ func (s *NoWrapper) MarshalJSON() ([]byte, error) { // Connect token // (https://developers.google.com/identity/protocols/OpenIDConnect). type OidcToken struct { - // Audience: Audience to be used when generating OIDC token. The - // audience claim identifies the recipients that the JWT is intended + // Audience: Optional. Audience to be used when generating OIDC token. + // The audience claim identifies the recipients that the JWT is intended // for. The audience value is a single case-sensitive string. Having // multiple values (array) for the audience field is not supported. More // info about the OIDC JWT token audience here: @@ -1155,7 +1159,7 @@ type OidcToken struct { // specified, the Push endpoint URL will be used. Audience string `json:"audience,omitempty"` - // ServiceAccountEmail: Service account email + // ServiceAccountEmail: Optional. Service account email // (https://cloud.google.com/iam/docs/service-accounts) used for // generating the OIDC token. For more information on setting up // authentication, see Push subscriptions @@ -1321,9 +1325,9 @@ func (s *PublishRequest) MarshalJSON() ([]byte, error) { // PublishResponse: Response for the `Publish` method. type PublishResponse struct { - // MessageIds: The server-assigned ID of each published message, in the - // same order as the messages in the request. IDs are guaranteed to be - // unique within the topic. + // MessageIds: Optional. The server-assigned ID of each published + // message, in the same order as the messages in the request. IDs are + // guaranteed to be unique within the topic. MessageIds []string `json:"messageIds,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1363,24 +1367,24 @@ func (s *PublishResponse) MarshalJSON() ([]byte, error) { // (https://cloud.google.com/pubsub/quotas) for more information about // message limits. type PubsubMessage struct { - // Attributes: Attributes for this message. If this field is empty, the - // message must contain non-empty data. This can be used to filter - // messages on the subscription. + // Attributes: Optional. Attributes for this message. If this field is + // empty, the message must contain non-empty data. This can be used to + // filter messages on the subscription. Attributes map[string]string `json:"attributes,omitempty"` - // Data: The message data field. If this field is empty, the message - // must contain at least one attribute. + // Data: Optional. The message data field. If this field is empty, the + // message must contain at least one attribute. Data string `json:"data,omitempty"` - // MessageId: ID of this message, assigned by the server when the - // message is published. Guaranteed to be unique within the topic. This - // value may be read by a subscriber that receives a `PubsubMessage` via - // a `Pull` call or a push delivery. It must not be populated by the - // publisher in a `Publish` call. + // MessageId: Optional. ID of this message, assigned by the server when + // the message is published. Guaranteed to be unique within the topic. + // This value may be read by a subscriber that receives a + // `PubsubMessage` via a `Pull` call or a push delivery. It must not be + // populated by the publisher in a `Publish` call. MessageId string `json:"messageId,omitempty"` - // OrderingKey: If non-empty, identifies related messages for which - // publish order should be respected. If a `Subscription` has + // OrderingKey: Optional. If non-empty, identifies related messages for + // which publish order should be respected. If a `Subscription` has // `enable_message_ordering` set to `true`, messages published with the // same non-empty `ordering_key` value will be delivered to subscribers // in the order in which they are received by the Pub/Sub system. All @@ -1389,9 +1393,9 @@ type PubsubMessage struct { // messages (https://cloud.google.com/pubsub/docs/ordering). OrderingKey string `json:"orderingKey,omitempty"` - // PublishTime: The time at which the message was published, populated - // by the server when it receives the `Publish` call. It must not be - // populated by the publisher in a `Publish` call. + // PublishTime: Optional. The time at which the message was published, + // populated by the server when it receives the `Publish` call. It must + // not be populated by the publisher in a `Publish` call. PublishTime string `json:"publishTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Attributes") to @@ -1464,12 +1468,12 @@ func (s *PullRequest) MarshalJSON() ([]byte, error) { // PullResponse: Response for the `Pull` method. type PullResponse struct { - // ReceivedMessages: Received Pub/Sub messages. The list will be empty - // if there are no more messages available in the backlog, or if no - // messages could be returned before the request timeout. For JSON, the - // response can be entirely empty. The Pub/Sub system may return fewer - // than the `maxMessages` requested even if there are more messages - // available in the backlog. + // ReceivedMessages: Optional. Received Pub/Sub messages. The list will + // be empty if there are no more messages available in the backlog, or + // if no messages could be returned before the request timeout. For + // JSON, the response can be entirely empty. The Pub/Sub system may + // return fewer than the `maxMessages` requested even if there are more + // messages available in the backlog. ReceivedMessages []*ReceivedMessage `json:"receivedMessages,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1502,15 +1506,15 @@ func (s *PullResponse) MarshalJSON() ([]byte, error) { // PushConfig: Configuration for a push delivery endpoint. type PushConfig struct { - // Attributes: Endpoint configuration attributes that can be used to - // control different aspects of the message delivery. The only currently - // supported attribute is `x-goog-version`, which you can use to change - // the format of the pushed message. This attribute indicates the - // version of the data expected by the endpoint. This controls the shape - // of the pushed message (i.e., its fields and metadata). If not present - // during the `CreateSubscription` call, it will default to the version - // of the Pub/Sub API used to make such call. If not present in a - // `ModifyPushConfig` call, its value will not be changed. + // Attributes: Optional. Endpoint configuration attributes that can be + // used to control different aspects of the message delivery. The only + // currently supported attribute is `x-goog-version`, which you can use + // to change the format of the pushed message. This attribute indicates + // the version of the data expected by the endpoint. This controls the + // shape of the pushed message (i.e., its fields and metadata). If not + // present during the `CreateSubscription` call, it will default to the + // version of the Pub/Sub API used to make such call. If not present in + // a `ModifyPushConfig` call, its value will not be changed. // `GetSubscription` calls will always return a valid version, even if // the subscription was created without this attribute. The only // supported values for the `x-goog-version` attribute are: * `v1beta1`: @@ -1519,21 +1523,22 @@ type PushConfig struct { // example: `attributes { "x-goog-version": "v1" }` Attributes map[string]string `json:"attributes,omitempty"` - // NoWrapper: When set, the payload to the push endpoint is not wrapped. + // NoWrapper: Optional. When set, the payload to the push endpoint is + // not wrapped. NoWrapper *NoWrapper `json:"noWrapper,omitempty"` - // OidcToken: If specified, Pub/Sub will generate and attach an OIDC JWT - // token as an `Authorization` header in the HTTP request for every - // pushed message. + // OidcToken: Optional. If specified, Pub/Sub will generate and attach + // an OIDC JWT token as an `Authorization` header in the HTTP request + // for every pushed message. OidcToken *OidcToken `json:"oidcToken,omitempty"` - // PubsubWrapper: When set, the payload to the push endpoint is in the - // form of the JSON representation of a PubsubMessage + // PubsubWrapper: Optional. When set, the payload to the push endpoint + // is in the form of the JSON representation of a PubsubMessage // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). PubsubWrapper *PubsubWrapper `json:"pubsubWrapper,omitempty"` - // PushEndpoint: A URL locating the endpoint to which messages should be - // pushed. For example, a Webhook endpoint might use + // PushEndpoint: Optional. A URL locating the endpoint to which messages + // should be pushed. For example, a Webhook endpoint might use // `https://example.com/push`. PushEndpoint string `json:"pushEndpoint,omitempty"` @@ -1562,15 +1567,16 @@ func (s *PushConfig) MarshalJSON() ([]byte, error) { // ReceivedMessage: A message and its corresponding acknowledgment ID. type ReceivedMessage struct { - // AckId: This ID can be used to acknowledge the received message. + // AckId: Optional. This ID can be used to acknowledge the received + // message. AckId string `json:"ackId,omitempty"` - // DeliveryAttempt: The approximate number of times that Cloud Pub/Sub - // has attempted to deliver the associated message to a subscriber. More - // precisely, this is 1 + (number of NACKs) + (number of ack_deadline - // exceeds) for this message. A NACK is any call to ModifyAckDeadline - // with a 0 deadline. An ack_deadline exceeds event is whenever a - // message is not acknowledged within ack_deadline. Note that + // DeliveryAttempt: Optional. The approximate number of times that + // Pub/Sub has attempted to deliver the associated message to a + // subscriber. More precisely, this is 1 + (number of NACKs) + (number + // of ack_deadline exceeds) for this message. A NACK is any call to + // ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is + // whenever a message is not acknowledged within ack_deadline. Note that // ack_deadline is initially Subscription.ackDeadlineSeconds, but may // get extended automatically by the client library. Upon the first // delivery of a given message, `delivery_attempt` will have a value of @@ -1578,7 +1584,7 @@ type ReceivedMessage struct { // DeadLetterPolicy is not set on the subscription, this will be 0. DeliveryAttempt int64 `json:"deliveryAttempt,omitempty"` - // Message: The message. + // Message: Optional. The message. Message *PubsubMessage `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "AckId") to @@ -1604,9 +1610,9 @@ func (s *ReceivedMessage) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RetryPolicy: A policy that specifies how Cloud Pub/Sub retries -// message delivery. Retry delay will be exponential based on provided -// minimum and maximum backoffs. +// RetryPolicy: A policy that specifies how Pub/Sub retries message +// delivery. Retry delay will be exponential based on provided minimum +// and maximum backoffs. // https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will // be triggered on NACKs or acknowledgement deadline exceeded events for // a given message. Retry Policy is implemented on a best effort basis. @@ -1614,14 +1620,14 @@ func (s *ReceivedMessage) MarshalJSON() ([]byte, error) { // configuration. That is, delay can be more or less than configured // backoff. type RetryPolicy struct { - // MaximumBackoff: The maximum delay between consecutive deliveries of a - // given message. Value should be between 0 and 600 seconds. Defaults to - // 600 seconds. + // MaximumBackoff: Optional. The maximum delay between consecutive + // deliveries of a given message. Value should be between 0 and 600 + // seconds. Defaults to 600 seconds. MaximumBackoff string `json:"maximumBackoff,omitempty"` - // MinimumBackoff: The minimum delay between consecutive deliveries of a - // given message. Value should be between 0 and 600 seconds. Defaults to - // 10 seconds. + // MinimumBackoff: Optional. The minimum delay between consecutive + // deliveries of a given message. Value should be between 0 and 600 + // seconds. Defaults to 10 seconds. MinimumBackoff string `json:"minimumBackoff,omitempty"` // ForceSendFields is a list of field names (e.g. "MaximumBackoff") to @@ -1733,7 +1739,8 @@ func (s *Schema) MarshalJSON() ([]byte, error) { // SchemaSettings: Settings for validating messages published against a // schema. type SchemaSettings struct { - // Encoding: The encoding of messages validated against `schema`. + // Encoding: Optional. The encoding of messages validated against + // `schema`. // // Possible values: // "ENCODING_UNSPECIFIED" - Unspecified @@ -1742,14 +1749,14 @@ type SchemaSettings struct { // schema types, binary encoding may not be available. Encoding string `json:"encoding,omitempty"` - // FirstRevisionId: The minimum (inclusive) revision allowed for - // validating messages. If empty or not present, allow any revision to - // be validated against last_revision or any revision created before. + // FirstRevisionId: Optional. The minimum (inclusive) revision allowed + // for validating messages. If empty or not present, allow any revision + // to be validated against last_revision or any revision created before. FirstRevisionId string `json:"firstRevisionId,omitempty"` - // LastRevisionId: The maximum (inclusive) revision allowed for - // validating messages. If empty or not present, allow any revision to - // be validated against first_revision or any revision created after. + // LastRevisionId: Optional. The maximum (inclusive) revision allowed + // for validating messages. If empty or not present, allow any revision + // to be validated against first_revision or any revision created after. LastRevisionId string `json:"lastRevisionId,omitempty"` // Schema: Required. The name of the schema that messages published @@ -1783,22 +1790,22 @@ func (s *SchemaSettings) MarshalJSON() ([]byte, error) { // SeekRequest: Request for the `Seek` method. type SeekRequest struct { - // Snapshot: The snapshot to seek to. The snapshot's topic must be the - // same as that of the provided subscription. Format is + // Snapshot: Optional. The snapshot to seek to. The snapshot's topic + // must be the same as that of the provided subscription. Format is // `projects/{project}/snapshots/{snap}`. Snapshot string `json:"snapshot,omitempty"` - // Time: The time to seek to. Messages retained in the subscription that - // were published before this time are marked as acknowledged, and - // messages retained in the subscription that were published after this - // time are marked as unacknowledged. Note that this operation affects - // only those messages retained in the subscription (configured by the - // combination of `message_retention_duration` and - // `retain_acked_messages`). For example, if `time` corresponds to a - // point before the message retention window (or to a point before the - // system's notion of the subscription creation time), only retained - // messages will be marked as unacknowledged, and already-expunged - // messages will not be restored. + // Time: Optional. The time to seek to. Messages retained in the + // subscription that were published before this time are marked as + // acknowledged, and messages retained in the subscription that were + // published after this time are marked as unacknowledged. Note that + // this operation affects only those messages retained in the + // subscription (configured by the combination of + // `message_retention_duration` and `retain_acked_messages`). For + // example, if `time` corresponds to a point before the message + // retention window (or to a point before the system's notion of the + // subscription creation time), only retained messages will be marked as + // unacknowledged, and already-expunged messages will not be restored. Time string `json:"time,omitempty"` // ForceSendFields is a list of field names (e.g. "Snapshot") to @@ -1869,28 +1876,28 @@ func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error) { // you can set the acknowledgment state of messages in an existing // subscription to the state captured by a snapshot. type Snapshot struct { - // ExpireTime: The snapshot is guaranteed to exist up until this time. A - // newly-created snapshot expires no later than 7 days from the time of - // its creation. Its exact lifetime is determined at creation by the - // existing backlog in the source subscription. Specifically, the - // lifetime of the snapshot is `7 days - (age of oldest unacked message - // in the subscription)`. For example, consider a subscription whose - // oldest unacked message is 3 days old. If a snapshot is created from - // this subscription, the snapshot -- which will always capture this - // 3-day-old backlog as long as the snapshot exists -- will expire in 4 - // days. The service will refuse to create a snapshot that would expire - // in less than 1 hour after creation. + // ExpireTime: Optional. The snapshot is guaranteed to exist up until + // this time. A newly-created snapshot expires no later than 7 days from + // the time of its creation. Its exact lifetime is determined at + // creation by the existing backlog in the source subscription. + // Specifically, the lifetime of the snapshot is `7 days - (age of + // oldest unacked message in the subscription)`. For example, consider a + // subscription whose oldest unacked message is 3 days old. If a + // snapshot is created from this subscription, the snapshot -- which + // will always capture this 3-day-old backlog as long as the snapshot + // exists -- will expire in 4 days. The service will refuse to create a + // snapshot that would expire in less than 1 hour after creation. ExpireTime string `json:"expireTime,omitempty"` - // Labels: See [Creating and managing labels] + // Labels: Optional. See [Creating and managing labels] // (https://cloud.google.com/pubsub/docs/labels). Labels map[string]string `json:"labels,omitempty"` - // Name: The name of the snapshot. + // Name: Optional. The name of the snapshot. Name string `json:"name,omitempty"` - // Topic: The name of the topic from which this snapshot is retaining - // messages. + // Topic: Optional. The name of the topic from which this snapshot is + // retaining messages. Topic string `json:"topic,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1925,88 +1932,90 @@ func (s *Snapshot) MarshalJSON() ([]byte, error) { // subscriber will pull and ack messages using API methods. At most one // of these fields may be set. type Subscription struct { - // AckDeadlineSeconds: The approximate amount of time (on a best-effort - // basis) Pub/Sub waits for the subscriber to acknowledge receipt before - // resending the message. In the interval after the message is delivered - // and before it is acknowledged, it is considered to be _outstanding_. - // During that time period, the message will not be redelivered (on a - // best-effort basis). For pull subscriptions, this value is used as the - // initial value for the ack deadline. To override this value for a - // given message, call `ModifyAckDeadline` with the corresponding - // `ack_id` if using non-streaming pull or send the `ack_id` in a - // `StreamingModifyAckDeadlineRequest` if using streaming pull. The - // minimum custom deadline you can specify is 10 seconds. The maximum - // custom deadline you can specify is 600 seconds (10 minutes). If this - // parameter is 0, a default value of 10 seconds is used. For push - // delivery, this value is also used to set the request timeout for the - // call to the push endpoint. If the subscriber never acknowledges the - // message, the Pub/Sub system will eventually redeliver the message. + // AckDeadlineSeconds: Optional. The approximate amount of time (on a + // best-effort basis) Pub/Sub waits for the subscriber to acknowledge + // receipt before resending the message. In the interval after the + // message is delivered and before it is acknowledged, it is considered + // to be _outstanding_. During that time period, the message will not be + // redelivered (on a best-effort basis). For pull subscriptions, this + // value is used as the initial value for the ack deadline. To override + // this value for a given message, call `ModifyAckDeadline` with the + // corresponding `ack_id` if using non-streaming pull or send the + // `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming + // pull. The minimum custom deadline you can specify is 10 seconds. The + // maximum custom deadline you can specify is 600 seconds (10 minutes). + // If this parameter is 0, a default value of 10 seconds is used. For + // push delivery, this value is also used to set the request timeout for + // the call to the push endpoint. If the subscriber never acknowledges + // the message, the Pub/Sub system will eventually redeliver the + // message. AckDeadlineSeconds int64 `json:"ackDeadlineSeconds,omitempty"` - // BigqueryConfig: If delivery to BigQuery is used with this + // BigqueryConfig: Optional. If delivery to BigQuery is used with this // subscription, this field is used to configure it. BigqueryConfig *BigQueryConfig `json:"bigqueryConfig,omitempty"` - // CloudStorageConfig: If delivery to Google Cloud Storage is used with - // this subscription, this field is used to configure it. + // CloudStorageConfig: Optional. If delivery to Google Cloud Storage is + // used with this subscription, this field is used to configure it. CloudStorageConfig *CloudStorageConfig `json:"cloudStorageConfig,omitempty"` - // DeadLetterPolicy: A policy that specifies the conditions for dead - // lettering messages in this subscription. If dead_letter_policy is not - // set, dead lettering is disabled. The Cloud Pub/Sub service account - // associated with this subscriptions's parent project (i.e., + // DeadLetterPolicy: Optional. A policy that specifies the conditions + // for dead lettering messages in this subscription. If + // dead_letter_policy is not set, dead lettering is disabled. The + // Pub/Sub service account associated with this subscriptions's parent + // project (i.e., // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must // have permission to Acknowledge() messages on this subscription. DeadLetterPolicy *DeadLetterPolicy `json:"deadLetterPolicy,omitempty"` - // Detached: Indicates whether the subscription is detached from its - // topic. Detached subscriptions don't receive messages from their topic - // and don't retain any backlog. `Pull` and `StreamingPull` requests - // will return FAILED_PRECONDITION. If the subscription is a push - // subscription, pushes to the endpoint will not be made. + // Detached: Optional. Indicates whether the subscription is detached + // from its topic. Detached subscriptions don't receive messages from + // their topic and don't retain any backlog. `Pull` and `StreamingPull` + // requests will return FAILED_PRECONDITION. If the subscription is a + // push subscription, pushes to the endpoint will not be made. Detached bool `json:"detached,omitempty"` - // EnableExactlyOnceDelivery: If true, Pub/Sub provides the following - // guarantees for the delivery of a message with a given value of - // `message_id` on this subscription: * The message sent to a subscriber - // is guaranteed not to be resent before the message's acknowledgement - // deadline expires. * An acknowledged message will not be resent to a - // subscriber. Note that subscribers may still receive multiple copies - // of a message when `enable_exactly_once_delivery` is true if the - // message was published multiple times by a publisher client. These - // copies are considered distinct by Pub/Sub and have distinct - // `message_id` values. + // EnableExactlyOnceDelivery: Optional. If true, Pub/Sub provides the + // following guarantees for the delivery of a message with a given value + // of `message_id` on this subscription: * The message sent to a + // subscriber is guaranteed not to be resent before the message's + // acknowledgement deadline expires. * An acknowledged message will not + // be resent to a subscriber. Note that subscribers may still receive + // multiple copies of a message when `enable_exactly_once_delivery` is + // true if the message was published multiple times by a publisher + // client. These copies are considered distinct by Pub/Sub and have + // distinct `message_id` values. EnableExactlyOnceDelivery bool `json:"enableExactlyOnceDelivery,omitempty"` - // EnableMessageOrdering: If true, messages published with the same - // `ordering_key` in `PubsubMessage` will be delivered to the + // EnableMessageOrdering: Optional. If true, messages published with the + // same `ordering_key` in `PubsubMessage` will be delivered to the // subscribers in the order in which they are received by the Pub/Sub // system. Otherwise, they may be delivered in any order. EnableMessageOrdering bool `json:"enableMessageOrdering,omitempty"` - // ExpirationPolicy: A policy that specifies the conditions for this - // subscription's expiration. A subscription is considered active as - // long as any connected subscriber is successfully consuming messages - // from the subscription or is issuing operations on the subscription. - // If `expiration_policy` is not set, a *default policy* with `ttl` of - // 31 days will be used. The minimum allowed value for + // ExpirationPolicy: Optional. A policy that specifies the conditions + // for this subscription's expiration. A subscription is considered + // active as long as any connected subscriber is successfully consuming + // messages from the subscription or is issuing operations on the + // subscription. If `expiration_policy` is not set, a *default policy* + // with `ttl` of 31 days will be used. The minimum allowed value for // `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but // `expiration_policy.ttl` is not set, the subscription never expires. ExpirationPolicy *ExpirationPolicy `json:"expirationPolicy,omitempty"` - // Filter: An expression written in the Pub/Sub filter language - // (https://cloud.google.com/pubsub/docs/filtering). If non-empty, then - // only `PubsubMessage`s whose `attributes` field matches the filter are - // delivered on this subscription. If empty, then no messages are - // filtered out. + // Filter: Optional. An expression written in the Pub/Sub filter + // language (https://cloud.google.com/pubsub/docs/filtering). If + // non-empty, then only `PubsubMessage`s whose `attributes` field + // matches the filter are delivered on this subscription. If empty, then + // no messages are filtered out. Filter string `json:"filter,omitempty"` - // Labels: See Creating and managing labels + // Labels: Optional. See Creating and managing labels // (https://cloud.google.com/pubsub/docs/labels). Labels map[string]string `json:"labels,omitempty"` - // MessageRetentionDuration: How long to retain unacknowledged messages - // in the subscription's backlog, from the moment a message is + // MessageRetentionDuration: Optional. How long to retain unacknowledged + // messages in the subscription's backlog, from the moment a message is // published. If `retain_acked_messages` is true, then this also // configures the retention of acknowledged messages, and thus // configures how far back in time a `Seek` can be done. Defaults to 7 @@ -2021,25 +2030,25 @@ type Subscription struct { // and 255 characters in length, and it must not start with "goog". Name string `json:"name,omitempty"` - // PushConfig: If push delivery is used with this subscription, this - // field is used to configure it. + // PushConfig: Optional. If push delivery is used with this + // subscription, this field is used to configure it. PushConfig *PushConfig `json:"pushConfig,omitempty"` - // RetainAckedMessages: Indicates whether to retain acknowledged - // messages. If true, then messages are not expunged from the - // subscription's backlog, even if they are acknowledged, until they + // RetainAckedMessages: Optional. Indicates whether to retain + // acknowledged messages. If true, then messages are not expunged from + // the subscription's backlog, even if they are acknowledged, until they // fall out of the `message_retention_duration` window. This must be // true if you would like to [`Seek` to a timestamp] // (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) // in the past to replay previously-acknowledged messages. RetainAckedMessages bool `json:"retainAckedMessages,omitempty"` - // RetryPolicy: A policy that specifies how Pub/Sub retries message - // delivery for this subscription. If not set, the default retry policy - // is applied. This generally implies that messages will be retried as - // soon as possible for healthy subscribers. RetryPolicy will be - // triggered on NACKs or acknowledgement deadline exceeded events for a - // given message. + // RetryPolicy: Optional. A policy that specifies how Pub/Sub retries + // message delivery for this subscription. If not set, the default retry + // policy is applied. This generally implies that messages will be + // retried as soon as possible for healthy subscribers. RetryPolicy will + // be triggered on NACKs or acknowledgement deadline exceeded events for + // a given message. RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"` // State: Output only. An output-only field indicating whether or not @@ -2171,18 +2180,18 @@ type TextConfig struct { // Topic: A topic resource. type Topic struct { - // KmsKeyName: The resource name of the Cloud KMS CryptoKey to be used - // to protect access to messages published on this topic. The expected - // format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. + // KmsKeyName: Optional. The resource name of the Cloud KMS CryptoKey to + // be used to protect access to messages published on this topic. The + // expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. KmsKeyName string `json:"kmsKeyName,omitempty"` - // Labels: See [Creating and managing labels] + // Labels: Optional. See [Creating and managing labels] // (https://cloud.google.com/pubsub/docs/labels). Labels map[string]string `json:"labels,omitempty"` - // MessageRetentionDuration: Indicates the minimum duration to retain a - // message after it is published to the topic. If this field is set, - // messages published to the topic in the last + // MessageRetentionDuration: Optional. Indicates the minimum duration to + // retain a message after it is published to the topic. If this field is + // set, messages published to the topic in the last // `message_retention_duration` are always available to subscribers. For // instance, it allows any attached subscription to seek to a timestamp // (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) @@ -2191,9 +2200,9 @@ type Topic struct { // subscriptions. Cannot be more than 31 days or less than 10 minutes. MessageRetentionDuration string `json:"messageRetentionDuration,omitempty"` - // MessageStoragePolicy: Policy constraining the set of Google Cloud - // Platform regions where messages published to the topic may be stored. - // If not present, then no constraints are in effect. + // MessageStoragePolicy: Optional. Policy constraining the set of Google + // Cloud Platform regions where messages published to the topic may be + // stored. If not present, then no constraints are in effect. MessageStoragePolicy *MessageStoragePolicy `json:"messageStoragePolicy,omitempty"` // Name: Required. The name of the topic. It must have the format @@ -2204,13 +2213,13 @@ type Topic struct { // in length, and it must not start with "goog". Name string `json:"name,omitempty"` - // SatisfiesPzs: Reserved for future use. This field is set only in - // responses from the server; it is ignored if it is set in any + // SatisfiesPzs: Optional. Reserved for future use. This field is set + // only in responses from the server; it is ignored if it is set in any // requests. SatisfiesPzs bool `json:"satisfiesPzs,omitempty"` - // SchemaSettings: Settings for validating messages published against a - // schema. + // SchemaSettings: Optional. Settings for validating messages published + // against a schema. SchemaSettings *SchemaSettings `json:"schemaSettings,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -5349,13 +5358,13 @@ func (c *ProjectsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnaps // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of snapshots to return.", + // "description": "Optional. Maximum number of snapshots to return.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data.", + // "description": "Optional. The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data.", // "location": "query", // "type": "string" // }, @@ -5417,7 +5426,7 @@ type ProjectsSnapshotsPatchCall struct { // you can set the acknowledgment state of messages in an existing // subscription to the state captured by a snapshot. // -// - name: The name of the snapshot. +// - name: Optional. The name of the snapshot. func (r *ProjectsSnapshotsService) Patch(name string, updatesnapshotrequest *UpdateSnapshotRequest) *ProjectsSnapshotsPatchCall { c := &ProjectsSnapshotsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -5525,7 +5534,7 @@ func (c *ProjectsSnapshotsPatchCall) Do(opts ...googleapi.CallOption) (*Snapshot // ], // "parameters": { // "name": { - // "description": "The name of the snapshot.", + // "description": "Optional. The name of the snapshot.", // "location": "path", // "pattern": "^projects/[^/]+/snapshots/[^/]+$", // "required": true, @@ -6900,13 +6909,13 @@ func (c *ProjectsSubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListS // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of subscriptions to return.", + // "description": "Optional. Maximum number of subscriptions to return.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.", + // "description": "Optional. The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.", // "location": "query", // "type": "string" // }, @@ -8749,13 +8758,13 @@ func (c *ProjectsTopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicsRe // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of topics to return.", + // "description": "Optional. Maximum number of topics to return.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.", + // "description": "Optional. The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.", // "location": "query", // "type": "string" // }, @@ -9542,13 +9551,13 @@ func (c *ProjectsTopicsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*Lis // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of snapshot names to return.", + // "description": "Optional. Maximum number of snapshot names to return.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.", + // "description": "Optional. The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.", // "location": "query", // "type": "string" // }, @@ -9738,13 +9747,13 @@ func (c *ProjectsTopicsSubscriptionsListCall) Do(opts ...googleapi.CallOption) ( // ], // "parameters": { // "pageSize": { - // "description": "Maximum number of subscription names to return.", + // "description": "Optional. Maximum number of subscription names to return.", // "format": "int32", // "location": "query", // "type": "integer" // }, // "pageToken": { - // "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.", + // "description": "Optional. The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.", // "location": "query", // "type": "string" // }, diff --git a/vmmigration/v1/vmmigration-api.json b/vmmigration/v1/vmmigration-api.json index f60e39a2161..4b636edf5e9 100644 --- a/vmmigration/v1/vmmigration-api.json +++ b/vmmigration/v1/vmmigration-api.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230518", + "revision": "20230622", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -3890,6 +3890,7 @@ "type": "string" }, "progressPercent": { + "deprecated": true, "description": "The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.", "format": "int32", "type": "integer" diff --git a/vmmigration/v1alpha1/vmmigration-api.json b/vmmigration/v1alpha1/vmmigration-api.json index 66ea9115f10..c840f891279 100644 --- a/vmmigration/v1alpha1/vmmigration-api.json +++ b/vmmigration/v1alpha1/vmmigration-api.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230518", + "revision": "20230622", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2389,6 +2389,7 @@ }, "computeEngineVmDetails": { "$ref": "TargetVMDetails", + "deprecated": true, "description": "Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.", "readOnly": true }, @@ -2455,6 +2456,7 @@ }, "targetDetails": { "$ref": "TargetVMDetails", + "deprecated": true, "description": "Output only. Details of the VM to create as the target of this clone job. Deprecated: Use compute_engine_target_details instead.", "readOnly": true } @@ -2749,6 +2751,7 @@ "id": "ComputeScheduling", "properties": { "automaticRestart": { + "deprecated": true, "type": "boolean" }, "minNodeCpus": { @@ -2818,6 +2821,7 @@ }, "computeEngineVmDetails": { "$ref": "TargetVMDetails", + "deprecated": true, "description": "Output only. Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_details instead.", "readOnly": true }, @@ -2844,6 +2848,7 @@ "type": "string" }, "progress": { + "deprecated": true, "description": "Output only. The current progress in percentage of the cutover job.", "format": "int32", "readOnly": true, @@ -2901,6 +2906,7 @@ }, "targetDetails": { "$ref": "TargetVMDetails", + "deprecated": true, "description": "Output only. Details of the VM to create as the target of this cutover job. Deprecated: Use compute_engine_target_details instead.", "readOnly": true } @@ -3513,6 +3519,7 @@ }, "computeEngineVmDefaults": { "$ref": "TargetVMDetails", + "deprecated": true, "description": "Details of the VM in Compute Engine. Deprecated: Use compute_engine_target_defaults instead." }, "createTime": { @@ -3636,6 +3643,7 @@ }, "targetDefaults": { "$ref": "TargetVMDetails", + "deprecated": true, "description": "The default configuration of the target VM that will be created in Google Cloud as a result of the migration. Deprecated: Use compute_engine_target_defaults instead." }, "updateTime": { @@ -3927,11 +3935,13 @@ "type": "string" }, "progress": { + "deprecated": true, "description": "The current progress in percentage of this cycle.", "format": "int32", "type": "integer" }, "progressPercent": { + "deprecated": true, "description": "The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately.", "format": "int32", "type": "integer" @@ -4074,6 +4084,7 @@ }, "error": { "$ref": "Status", + "deprecated": true, "description": "Output only. Provides details on the state of the Source in case of an error.", "readOnly": true }, @@ -4183,6 +4194,7 @@ "type": "object" }, "TargetVMDetails": { + "deprecated": true, "description": "TargetVMDetails is a collection of details for creating a VM in a target Compute Engine project.", "id": "TargetVMDetails", "properties": { @@ -4293,6 +4305,7 @@ "type": "array" }, "project": { + "deprecated": true, "description": "Output only. The project in which to create the VM.", "readOnly": true, "type": "string" @@ -4454,6 +4467,7 @@ "type": "array" }, "vmsCount": { + "deprecated": true, "description": "Output only. Total number of VMs included in the report.", "format": "int32", "readOnly": true, @@ -4486,6 +4500,7 @@ "id": "VmUtilizationMetrics", "properties": { "cpuAverage": { + "deprecated": true, "description": "Average CPU usage, percent.", "format": "int32", "type": "integer" @@ -4496,6 +4511,7 @@ "type": "integer" }, "cpuMax": { + "deprecated": true, "description": "Max CPU usage, percent.", "format": "int32", "type": "integer" @@ -4506,6 +4522,7 @@ "type": "integer" }, "diskIoRateAverage": { + "deprecated": true, "description": "Average disk IO rate, in kilobytes per second.", "format": "int64", "type": "string" @@ -4516,6 +4533,7 @@ "type": "string" }, "diskIoRateMax": { + "deprecated": true, "description": "Max disk IO rate, in kilobytes per second.", "format": "int64", "type": "string" @@ -4526,6 +4544,7 @@ "type": "string" }, "memoryAverage": { + "deprecated": true, "description": "Average memory usage, percent.", "format": "int32", "type": "integer" @@ -4536,6 +4555,7 @@ "type": "integer" }, "memoryMax": { + "deprecated": true, "description": "Max memory usage, percent.", "format": "int32", "type": "integer" @@ -4546,6 +4566,7 @@ "type": "integer" }, "networkThroughputAverage": { + "deprecated": true, "description": "Average network throughput (combined transmit-rates and receive-rates), in kilobytes per second.", "format": "int64", "type": "string" @@ -4556,6 +4577,7 @@ "type": "string" }, "networkThroughputMax": { + "deprecated": true, "description": "Max network throughput (combined transmit-rates and receive-rates), in kilobytes per second.", "format": "int64", "type": "string" @@ -4615,6 +4637,7 @@ "type": "string" }, "committedStorage": { + "deprecated": true, "description": "The total size of the storage allocated to the VM in MB.", "format": "int64", "type": "string"