From 3e83ea6f3926a6fbdd92e05db7f4e4705e7789ba Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 15 Nov 2023 00:22:15 -0800 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2263) --- .../v1/androidenterprise-api.json | 14 +- androidenterprise/v1/androidenterprise-gen.go | 25 +- .../v1/blockchainnodeengine-api.json | 12 +- .../v1/blockchainnodeengine-gen.go | 8 + cloudfunctions/v1/cloudfunctions-api.json | 5 +- cloudfunctions/v1/cloudfunctions-gen.go | 12 +- compute/v0.beta/compute-api.json | 30 +- compute/v0.beta/compute-gen.go | 26 ++ .../v1/contactcenterinsights-api.json | 20 +- .../v1/contactcenterinsights-gen.go | 28 +- .../v1alpha/discoveryengine-api.json | 102 ++++- .../v1alpha/discoveryengine-gen.go | 433 +++++++++++++++++- .../v1beta/discoveryengine-api.json | 100 +++- discoveryengine/v1beta/discoveryengine-gen.go | 419 ++++++++++++++++- domains/v1/domains-api.json | 146 ++++-- domains/v1/domains-gen.go | 369 +++++++++------ domains/v1alpha2/domains-api.json | 146 ++++-- domains/v1alpha2/domains-gen.go | 369 +++++++++------ domains/v1beta1/domains-api.json | 146 ++++-- domains/v1beta1/domains-gen.go | 369 +++++++++------ serviceusage/v1/serviceusage-api.json | 79 +++- serviceusage/v1/serviceusage-gen.go | 100 ++++ serviceusage/v1beta1/serviceusage-api.json | 79 +++- serviceusage/v1beta1/serviceusage-gen.go | 100 ++++ speech/v1/speech-api.json | 43 +- speech/v1/speech-gen.go | 86 +++- speech/v1p1beta1/speech-api.json | 6 +- speech/v1p1beta1/speech-gen.go | 7 +- sqladmin/v1/sqladmin-api.json | 37 +- sqladmin/v1/sqladmin-gen.go | 33 +- sqladmin/v1beta4/sqladmin-api.json | 38 +- sqladmin/v1beta4/sqladmin-gen.go | 36 +- 32 files changed, 2809 insertions(+), 614 deletions(-) diff --git a/androidenterprise/v1/androidenterprise-api.json b/androidenterprise/v1/androidenterprise-api.json index 1a3504370e5..e596d13a6ee 100644 --- a/androidenterprise/v1/androidenterprise-api.json +++ b/androidenterprise/v1/androidenterprise-api.json @@ -2649,7 +2649,7 @@ } } }, - "revision": "20231107", + "revision": "20231113", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -3207,7 +3207,7 @@ "description": "The device report updated with the latest app states." }, "retailBrand": { - "description": "Retail brand for the device, if set. See https://developer.android.com/reference/android/os/Build.html#BRAND", + "description": "Retail brand for the device, if set. See android.os.Build.BRAND", "type": "string" }, "sdkVersion": { @@ -3990,11 +3990,11 @@ "id": "Permission", "properties": { "description": { - "description": "A longer description of the Permissions resource, giving more details of what it affects. This field may be absent.", + "description": "A longer description of the Permissions resource, giving more details of what it affects.", "type": "string" }, "name": { - "description": "The name of the permission. This field may be absent.", + "description": "The name of the permission.", "type": "string" }, "permissionId": { @@ -4010,7 +4010,7 @@ "properties": { "autoUpdatePolicy": { "deprecated": true, - "description": "Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. \"choiceToTheUser\" allows the device's user to configure the app update policy. \"always\" enables auto updates. \"never\" disables auto updates. \"wifiOnly\" enables auto updates only when the device is connected to wifi.", + "description": "Controls when automatic app updates on the device can be applied. Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, autoUpdatePolicy has no effect. \"choiceToTheUser\" allows the device's user to configure the app update policy. \"always\" enables auto updates. \"never\" disables auto updates. \"wifiOnly\" enables auto updates only when the device is connected to wifi.", "enum": [ "autoUpdatePolicyUnspecified", "choiceToTheUser", @@ -4361,7 +4361,7 @@ "description": "The auto-install policy for the product." }, "autoUpdateMode": { - "description": "The auto-update mode for the product.", + "description": "The auto-update mode for the product. When autoUpdateMode is used, it always takes precedence over the user's choice. So when a user makes changes to the device settings manually, these changes are ignored.", "enum": [ "autoUpdateModeUnspecified", "autoUpdateDefault", @@ -4377,7 +4377,7 @@ "type": "string" }, "enterpriseAuthenticationAppLinkConfigs": { - "description": "An authentication URL configuration for the authenticator app of an identity provider. This helps to launch the identity provider's authenticator app during the authentication happening in a private app using Android WebView. Authenticator app should already be the [default handler](https://developer.android.com/training/app-links/verify-site-associations) for the authentication url on the device.", + "description": "An authentication URL configuration for the authenticator app of an identity provider. This helps to launch the identity provider's authenticator app during the authentication happening in a private app using Android WebView. Authenticator app should already be the default handler for the authentication url on the device.", "items": { "$ref": "EnterpriseAuthenticationAppLinkConfig" }, diff --git a/androidenterprise/v1/androidenterprise-gen.go b/androidenterprise/v1/androidenterprise-gen.go index 185f41ab31e..c7efc4f6a73 100644 --- a/androidenterprise/v1/androidenterprise-gen.go +++ b/androidenterprise/v1/androidenterprise-gen.go @@ -1250,7 +1250,7 @@ type Device struct { Report *DeviceReport `json:"report,omitempty"` // RetailBrand: Retail brand for the device, if set. See - // https://developer.android.com/reference/android/os/Build.html#BRAND + // android.os.Build.BRAND RetailBrand string `json:"retailBrand,omitempty"` // SdkVersion: API compatibility version. @@ -2726,10 +2726,10 @@ func (s *PageInfo) MarshalJSON() ([]byte, error) { // enterprise. type Permission struct { // Description: A longer description of the Permissions resource, giving - // more details of what it affects. This field may be absent. + // more details of what it affects. Description string `json:"description,omitempty"` - // Name: The name of the permission. This field may be absent. + // Name: The name of the permission. Name string `json:"name,omitempty"` // PermissionId: An opaque string uniquely identifying the permission. @@ -2764,10 +2764,11 @@ func (s *Permission) MarshalJSON() ([]byte, error) { // Policy: The device policy for a given managed device. type Policy struct { - // AutoUpdatePolicy: Recommended alternative: autoUpdateMode which is - // set per app, provides greater flexibility around update frequency. - // When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or - // AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. + // AutoUpdatePolicy: Controls when automatic app updates on the device + // can be applied. Recommended alternative: autoUpdateMode which is set + // per app, provides greater flexibility around update frequency. When + // autoUpdateMode is set to AUTO_UPDATE_POSTPONED or + // AUTO_UPDATE_HIGH_PRIORITY, autoUpdatePolicy has no effect. // "choiceToTheUser" allows the device's user to configure the app // update policy. "always" enables auto updates. "never" disables auto // updates. "wifiOnly" enables auto updates only when the device is @@ -3173,7 +3174,10 @@ type ProductPolicy struct { // AutoInstallPolicy: The auto-install policy for the product. AutoInstallPolicy *AutoInstallPolicy `json:"autoInstallPolicy,omitempty"` - // AutoUpdateMode: The auto-update mode for the product. + // AutoUpdateMode: The auto-update mode for the product. When + // autoUpdateMode is used, it always takes precedence over the user's + // choice. So when a user makes changes to the device settings manually, + // these changes are ignored. // // Possible values: // "autoUpdateModeUnspecified" - Unspecified. Defaults to @@ -3201,9 +3205,8 @@ type ProductPolicy struct { // configuration for the authenticator app of an identity provider. This // helps to launch the identity provider's authenticator app during the // authentication happening in a private app using Android WebView. - // Authenticator app should already be the default handler - // (https://developer.android.com/training/app-links/verify-site-associations) - // for the authentication url on the device. + // Authenticator app should already be the default handler for the + // authentication url on the device. EnterpriseAuthenticationAppLinkConfigs []*EnterpriseAuthenticationAppLinkConfig `json:"enterpriseAuthenticationAppLinkConfigs,omitempty"` // ManagedConfiguration: The managed configuration for the product. diff --git a/blockchainnodeengine/v1/blockchainnodeengine-api.json b/blockchainnodeengine/v1/blockchainnodeengine-api.json index 230406e5283..a6c2e149eda 100644 --- a/blockchainnodeengine/v1/blockchainnodeengine-api.json +++ b/blockchainnodeengine/v1/blockchainnodeengine-api.json @@ -487,7 +487,7 @@ } } }, - "revision": "20231011", + "revision": "20231108", "rootUrl": "https://blockchainnodeengine.googleapis.com/", "schemas": { "BlockchainNode": { @@ -533,6 +533,10 @@ "readOnly": true, "type": "string" }, + "privateServiceConnectEnabled": { + "description": "Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. See https://cloud.google.com/vpc/docs/private-service-connect.", + "type": "boolean" + }, "state": { "description": "Output only. A status representing the state of the node.", "enum": [ @@ -671,13 +675,15 @@ "NETWORK_UNSPECIFIED", "MAINNET", "TESTNET_GOERLI_PRATER", - "TESTNET_SEPOLIA" + "TESTNET_SEPOLIA", + "TESTNET_HOLESKY" ], "enumDescriptions": [ "The network has not been specified, but should be.", "The Ethereum Mainnet.", "The Ethereum Testnet based on Goerli protocol.", - "The Ethereum Testnet based on Sepolia/Bepolia protocol. See https://github.com/eth-clients/sepolia." + "The Ethereum Testnet based on Sepolia/Bepolia protocol. See https://github.com/eth-clients/sepolia.", + "The Ethereum Testnet based on Holesky specification. See https://github.com/eth-clients/holesky." ], "type": "string" }, diff --git a/blockchainnodeengine/v1/blockchainnodeengine-gen.go b/blockchainnodeengine/v1/blockchainnodeengine-gen.go index 8d02465bdd4..1b7ac9a25b7 100644 --- a/blockchainnodeengine/v1/blockchainnodeengine-gen.go +++ b/blockchainnodeengine/v1/blockchainnodeengine-gen.go @@ -225,6 +225,12 @@ type BlockchainNode struct { // `projects/my-project/locations/us-central1/blockchainNodes/my-node`. Name string `json:"name,omitempty"` + // PrivateServiceConnectEnabled: Optional. When true, the node is only + // accessible via Private Service Connect; no public endpoints are + // exposed. Otherwise, the node is only accessible via public endpoints. + // See https://cloud.google.com/vpc/docs/private-service-connect. + PrivateServiceConnectEnabled bool `json:"privateServiceConnectEnabled,omitempty"` + // State: Output only. A status representing the state of the node. // // Possible values: @@ -413,6 +419,8 @@ type EthereumDetails struct { // protocol. // "TESTNET_SEPOLIA" - The Ethereum Testnet based on Sepolia/Bepolia // protocol. See https://github.com/eth-clients/sepolia. + // "TESTNET_HOLESKY" - The Ethereum Testnet based on Holesky + // specification. See https://github.com/eth-clients/holesky. Network string `json:"network,omitempty"` // NodeType: Immutable. The type of Ethereum node. diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json index 7832394a824..b8b013fe9be 100644 --- a/cloudfunctions/v1/cloudfunctions-api.json +++ b/cloudfunctions/v1/cloudfunctions-api.json @@ -552,7 +552,7 @@ } } }, - "revision": "20231012", + "revision": "20231109", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -768,7 +768,8 @@ "type": "string" }, "network": { - "description": "The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where `{project}` is a project id where the network is defined, and `{network}` is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.", + "deprecated": true, + "description": "Deprecated: use vpc_connector", "type": "string" }, "runtime": { diff --git a/cloudfunctions/v1/cloudfunctions-gen.go b/cloudfunctions/v1/cloudfunctions-gen.go index 3c0c48a4ab0..6236aa6dfcd 100644 --- a/cloudfunctions/v1/cloudfunctions-gen.go +++ b/cloudfunctions/v1/cloudfunctions-gen.go @@ -581,17 +581,7 @@ type CloudFunction struct { // `projects/*/locations/*/functions/*` Name string `json:"name,omitempty"` - // Network: The VPC Network that this cloud function can connect to. It - // can be either the fully-qualified URI, or the short name of the - // network resource. If the short network name is used, the network must - // belong to the same project. Otherwise, it must belong to a project - // within the same organization. The format of this field is either - // `projects/{project}/global/networks/{network}` or `{network}`, where - // `{project}` is a project id where the network is defined, and - // `{network}` is the short name of the network. This field is mutually - // exclusive with `vpc_connector` and will be replaced by it. See the - // VPC documentation (https://cloud.google.com/compute/docs/vpc) for - // more information on connecting Cloud projects. + // Network: Deprecated: use vpc_connector Network string `json:"network,omitempty"` // Runtime: The runtime in which to run the function. Required when diff --git a/compute/v0.beta/compute-api.json b/compute/v0.beta/compute-api.json index 9693a89a261..fae8744d0c5 100644 --- a/compute/v0.beta/compute-api.json +++ b/compute/v0.beta/compute-api.json @@ -40215,7 +40215,7 @@ } } }, - "revision": "20231031", + "revision": "20231110", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -73844,6 +73844,10 @@ "format": "uint32", "type": "integer" }, + "identifierRange": { + "description": "Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this \"router ID\".", + "type": "string" + }, "keepaliveInterval": { "description": "The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.", "format": "uint32", @@ -73920,6 +73924,10 @@ ], "type": "string" }, + "enableIpv4": { + "description": "Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.", + "type": "boolean" + }, "enableIpv6": { "description": "Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.", "type": "boolean" @@ -73932,6 +73940,10 @@ "description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.", "type": "string" }, + "ipv4NexthopAddress": { + "description": "IPv4 address of the interface inside Google Cloud Platform.", + "type": "string" + }, "ipv6NexthopAddress": { "description": "IPv6 address of the interface inside Google Cloud Platform.", "type": "string" @@ -73976,6 +73988,10 @@ "description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.", "type": "string" }, + "peerIpv4NexthopAddress": { + "description": "IPv4 address of the BGP interface outside Google Cloud Platform.", + "type": "string" + }, "peerIpv6NexthopAddress": { "description": "IPv6 address of the BGP interface outside Google Cloud Platform.", "type": "string" @@ -74039,6 +74055,18 @@ "description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.", "type": "string" }, + "ipVersion": { + "description": "IP version of this interface.", + "enum": [ + "IPV4", + "IPV6" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "linkedInterconnectAttachment": { "description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", "type": "string" diff --git a/compute/v0.beta/compute-gen.go b/compute/v0.beta/compute-gen.go index dc9497db123..58754f57080 100644 --- a/compute/v0.beta/compute-gen.go +++ b/compute/v0.beta/compute-gen.go @@ -49173,6 +49173,13 @@ type RouterBgp struct { // have the same local ASN. Asn int64 `json:"asn,omitempty"` + // IdentifierRange: Explicitly specifies a range of valid BGP + // Identifiers for this Router. It is provided as a link-local IPv4 + // range (from 169.254.0.0/16), of size at least /30, even if the BGP + // sessions are over IPv6. It must not overlap with any IPv4 BGP session + // ranges. Other vendors commonly call this "router ID". + IdentifierRange string `json:"identifierRange,omitempty"` + // KeepaliveInterval: The interval in seconds between BGP keepalive // messages that are sent to the peer. Hold time is three times the // interval at which keepalive messages are sent, and the hold time is @@ -49266,6 +49273,10 @@ type RouterBgpPeer struct { // "TRUE" Enable string `json:"enable,omitempty"` + // EnableIpv4: Enable IPv4 traffic over BGP Peer. It is enabled by + // default if the peerIpAddress is version 4. + EnableIpv4 bool `json:"enableIpv4,omitempty"` + // EnableIpv6: Enable IPv6 traffic over BGP Peer. If not specified, it // is disabled by default. EnableIpv6 bool `json:"enableIpv6,omitempty"` @@ -49277,6 +49288,10 @@ type RouterBgpPeer struct { // Only IPv4 is supported. IpAddress string `json:"ipAddress,omitempty"` + // Ipv4NexthopAddress: IPv4 address of the interface inside Google Cloud + // Platform. + Ipv4NexthopAddress string `json:"ipv4NexthopAddress,omitempty"` + // Ipv6NexthopAddress: IPv6 address of the interface inside Google Cloud // Platform. Ipv6NexthopAddress string `json:"ipv6NexthopAddress,omitempty"` @@ -49324,6 +49339,10 @@ type RouterBgpPeer struct { // Platform. Only IPv4 is supported. PeerIpAddress string `json:"peerIpAddress,omitempty"` + // PeerIpv4NexthopAddress: IPv4 address of the BGP interface outside + // Google Cloud Platform. + PeerIpv4NexthopAddress string `json:"peerIpv4NexthopAddress,omitempty"` + // PeerIpv6NexthopAddress: IPv6 address of the BGP interface outside // Google Cloud Platform. PeerIpv6NexthopAddress string `json:"peerIpv6NexthopAddress,omitempty"` @@ -49454,6 +49473,13 @@ type RouterInterface struct { // interface. IpRange string `json:"ipRange,omitempty"` + // IpVersion: IP version of this interface. + // + // Possible values: + // "IPV4" + // "IPV6" + IpVersion string `json:"ipVersion,omitempty"` + // LinkedInterconnectAttachment: URI of the linked Interconnect // attachment. It must be in the same region as the router. Each // interface can have one linked resource, which can be a VPN tunnel, an diff --git a/contactcenterinsights/v1/contactcenterinsights-api.json b/contactcenterinsights/v1/contactcenterinsights-api.json index d05c53eff2f..f9f22670927 100644 --- a/contactcenterinsights/v1/contactcenterinsights-api.json +++ b/contactcenterinsights/v1/contactcenterinsights-api.json @@ -210,7 +210,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource to create analyses in. Format: projects/{project}/locations/{location}", + "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1412,7 +1412,7 @@ } } }, - "revision": "20231106", + "revision": "20231113", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -1790,7 +1790,7 @@ "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest", "properties": { "filter": { - "description": "Filter used to select the subset of conversations to analyze.", + "description": "Filter used to select the subset of conversations to delete.", "type": "string" }, "force": { @@ -1798,19 +1798,19 @@ "type": "boolean" }, "maxDeleteCount": { - "description": "Maximum number of conversations to delete. The default is 1000. It can be changed by setting the `max_delete_count` field.", + "description": "Maximum number of conversations to delete.", "format": "int32", "type": "integer" }, "parent": { - "description": "Required. The parent resource to create analyses in. Format: projects/{project}/locations/{location}", + "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse": { - "description": "The response for a bulk analyze conversations operation.", + "description": "The response for a bulk delete conversations operation.", "id": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse", "properties": {}, "type": "object" @@ -4192,7 +4192,7 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest", "properties": { "filter": { - "description": "Filter used to select the subset of conversations to analyze.", + "description": "Filter used to select the subset of conversations to delete.", "type": "string" }, "force": { @@ -4200,19 +4200,19 @@ "type": "boolean" }, "maxDeleteCount": { - "description": "Maximum number of conversations to delete. The default is 1000. It can be changed by setting the `max_delete_count` field.", + "description": "Maximum number of conversations to delete.", "format": "int32", "type": "integer" }, "parent": { - "description": "Required. The parent resource to create analyses in. Format: projects/{project}/locations/{location}", + "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", "type": "string" } }, "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse": { - "description": "The response for a bulk analyze conversations operation.", + "description": "The response for a bulk delete conversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse", "properties": {}, "type": "object" diff --git a/contactcenterinsights/v1/contactcenterinsights-gen.go b/contactcenterinsights/v1/contactcenterinsights-gen.go index 4bcc96ca4ee..17b699ceeda 100644 --- a/contactcenterinsights/v1/contactcenterinsights-gen.go +++ b/contactcenterinsights/v1/contactcenterinsights-gen.go @@ -843,7 +843,7 @@ func (s *GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata) Mars // GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: The // request to delete conversations in bulk. type GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest struct { - // Filter: Filter used to select the subset of conversations to analyze. + // Filter: Filter used to select the subset of conversations to delete. Filter string `json:"filter,omitempty"` // Force: If set to true, all of this conversation's analyses will also @@ -851,13 +851,11 @@ type GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest struct { // conversation has no analyses. Force bool `json:"force,omitempty"` - // MaxDeleteCount: Maximum number of conversations to delete. The - // default is 1000. It can be changed by setting the `max_delete_count` - // field. + // MaxDeleteCount: Maximum number of conversations to delete. MaxDeleteCount int64 `json:"maxDeleteCount,omitempty"` - // Parent: Required. The parent resource to create analyses in. Format: - // projects/{project}/locations/{location} + // Parent: Required. The parent resource to delete conversations from. + // Format: projects/{project}/locations/{location} Parent string `json:"parent,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to @@ -884,7 +882,7 @@ func (s *GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest) Marsh } // GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: -// The response for a bulk analyze conversations operation. +// The response for a bulk delete conversations operation. type GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse struct { } @@ -4793,7 +4791,7 @@ func (s *GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata // GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest // : The request to delete conversations in bulk. type GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest struct { - // Filter: Filter used to select the subset of conversations to analyze. + // Filter: Filter used to select the subset of conversations to delete. Filter string `json:"filter,omitempty"` // Force: If set to true, all of this conversation's analyses will also @@ -4801,13 +4799,11 @@ type GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest stru // conversation has no analyses. Force bool `json:"force,omitempty"` - // MaxDeleteCount: Maximum number of conversations to delete. The - // default is 1000. It can be changed by setting the `max_delete_count` - // field. + // MaxDeleteCount: Maximum number of conversations to delete. MaxDeleteCount int64 `json:"maxDeleteCount,omitempty"` - // Parent: Required. The parent resource to create analyses in. Format: - // projects/{project}/locations/{location} + // Parent: Required. The parent resource to delete conversations from. + // Format: projects/{project}/locations/{location} Parent string `json:"parent,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to @@ -4834,7 +4830,7 @@ func (s *GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest) } // GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRespons -// e: The response for a bulk analyze conversations operation. +// e: The response for a bulk delete conversations operation. type GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse struct { } @@ -7927,7 +7923,7 @@ type ProjectsLocationsConversationsBulkDeleteCall struct { // BulkDelete: Deletes multiple conversations in a single request. // -// - parent: The parent resource to create analyses in. Format: +// - parent: The parent resource to delete conversations from. Format: // projects/{project}/locations/{location}. func (r *ProjectsLocationsConversationsService) BulkDelete(parent string, googlecloudcontactcenterinsightsv1bulkdeleteconversationsrequest *GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest) *ProjectsLocationsConversationsBulkDeleteCall { c := &ProjectsLocationsConversationsBulkDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -8036,7 +8032,7 @@ func (c *ProjectsLocationsConversationsBulkDeleteCall) Do(opts ...googleapi.Call // ], // "parameters": { // "parent": { - // "description": "Required. The parent resource to create analyses in. Format: projects/{project}/locations/{location}", + // "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+$", // "required": true, diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 028cec4cce6..a2f0179624a 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -227,6 +227,80 @@ "resources": { "collections": { "resources": { + "dataConnector": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataConnector.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataConnector.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "dataStores": { "methods": { "completeQuery": { @@ -1710,7 +1784,7 @@ }, "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -3462,7 +3536,7 @@ } } }, - "revision": "20231102", + "revision": "20231110", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4464,6 +4538,20 @@ "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical." + ], + "type": "string" + }, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -4516,17 +4604,17 @@ "properties": { "agentCreationConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using GetEngine or ListEngine API after engine creation." + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using GetEngine or ListEngine API after engine creation. Please use Engine.chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.", + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using GetEngine or ListEngine API after engine creation.", + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { "business": { @@ -5710,6 +5798,10 @@ "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", + "type": "string" + }, "contentSearchSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index b35a8dd865c..1e5c401afa7 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -198,6 +198,7 @@ type ProjectsLocationsService struct { func NewProjectsLocationsCollectionsService(s *Service) *ProjectsLocationsCollectionsService { rs := &ProjectsLocationsCollectionsService{s: s} + rs.DataConnector = NewProjectsLocationsCollectionsDataConnectorService(s) rs.DataStores = NewProjectsLocationsCollectionsDataStoresService(s) rs.Engines = NewProjectsLocationsCollectionsEnginesService(s) rs.Operations = NewProjectsLocationsCollectionsOperationsService(s) @@ -207,6 +208,8 @@ func NewProjectsLocationsCollectionsService(s *Service) *ProjectsLocationsCollec type ProjectsLocationsCollectionsService struct { s *Service + DataConnector *ProjectsLocationsCollectionsDataConnectorService + DataStores *ProjectsLocationsCollectionsDataStoresService Engines *ProjectsLocationsCollectionsEnginesService @@ -214,6 +217,27 @@ type ProjectsLocationsCollectionsService struct { Operations *ProjectsLocationsCollectionsOperationsService } +func NewProjectsLocationsCollectionsDataConnectorService(s *Service) *ProjectsLocationsCollectionsDataConnectorService { + rs := &ProjectsLocationsCollectionsDataConnectorService{s: s} + rs.Operations = NewProjectsLocationsCollectionsDataConnectorOperationsService(s) + return rs +} + +type ProjectsLocationsCollectionsDataConnectorService struct { + s *Service + + Operations *ProjectsLocationsCollectionsDataConnectorOperationsService +} + +func NewProjectsLocationsCollectionsDataConnectorOperationsService(s *Service) *ProjectsLocationsCollectionsDataConnectorOperationsService { + rs := &ProjectsLocationsCollectionsDataConnectorOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsDataConnectorOperationsService struct { + s *Service +} + func NewProjectsLocationsCollectionsDataStoresService(s *Service) *ProjectsLocationsCollectionsDataStoresService { rs := &ProjectsLocationsCollectionsDataStoresService{s: s} rs.Branches = NewProjectsLocationsCollectionsDataStoresBranchesService(s) @@ -2418,6 +2442,18 @@ type GoogleCloudDiscoveryengineV1alphaEngine struct { // human readable. UTF-8 encoded string with limit of 1024 characters. DisplayName string `json:"displayName,omitempty"` + // IndustryVertical: The industry vertical that the engine registers. + // The restriction of the Engine industry vertical is based on + // DataStore: If unspecified, default to `GENERIC`. Vertical on Engine + // has to match vertical of the DataStore liniked to the engine. + // + // Possible values: + // "INDUSTRY_VERTICAL_UNSPECIFIED" - Value used when unset. + // "GENERIC" - The generic vertical for documents that are not + // specific to any industry vertical. + // "MEDIA" - The media industry vertical. + IndustryVertical string `json:"industryVertical,omitempty"` + // MediaRecommendationEngineConfig: Configurations for the Media Engine. // Only applicable on the data stores with solution_type // SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. @@ -2493,8 +2529,8 @@ type GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig struct { // AgentCreationConfig: The configurationt generate the Dialogflow agent // that is associated to this Engine. Note that these configurations are // one-time consumed by and passed to Dialogflow service. It means they - // cannot be retrieved using GetEngine or ListEngine API after engine - // creation. + // cannot be retrieved using EngineService.GetEngine or + // EngineService.ListEngines API after engine creation. AgentCreationConfig *GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig `json:"agentCreationConfig,omitempty"` // DialogflowAgentToLink: The resource name of an exist Dialogflow agent @@ -2503,10 +2539,10 @@ type GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig struct { // links the agent with the Chat engine. Format: // `projects//locations//agents/`. Note that the // `dialogflow_agent_to_link` are one-time consumed by and passed to - // Dialogflow service. It means they cannot be retrieved using GetEngine - // or ListEngine API after engine creation. Please use - // Engine.chat_engine_metadata.dialogflow_agent for actual agent - // association after Engine is created. + // Dialogflow service. It means they cannot be retrieved using + // EngineService.GetEngine or EngineService.ListEngines API after engine + // creation. Please use chat_engine_metadata.dialogflow_agent for actual + // agent association after Engine is created. DialogflowAgentToLink string `json:"dialogflowAgentToLink,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentCreationConfig") @@ -2536,8 +2572,9 @@ func (s *GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig) MarshalJSON() // GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationCo // nfig: Configurations for generating a Dialogflow agent. Note that // these configurations are one-time consumed by and passed to -// Dialogflow service. It means they cannot be retrieved using GetEngine -// or ListEngine API after engine creation. +// Dialogflow service. It means they cannot be retrieved using +// EngineService.GetEngine or EngineService.ListEngines API after engine +// creation. type GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig struct { // Business: Name of the company, organization or other entity that the // agent represents. Used for knowledge connector LLM prompt and for @@ -4739,6 +4776,17 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // branch. Branch string `json:"branch,omitempty"` + // CanonicalFilter: The default filter that is applied when a user + // performs a search without checking any filters on the search page. + // The filter applied to every search request when quality improvement + // such as query expansion is needed. In the case a query does not have + // a sufficient amount of results this filter will be used to determine + // whether or not to enable the query expansion flow. The original + // filter will still be used for the query expanded search. This field + // is strongly recommended to achieve high search quality. For more + // information about filter syntax, see SearchRequest.filter. + CanonicalFilter string `json:"canonicalFilter,omitempty"` + // ContentSearchSpec: A specification for configuring the behavior of // content search. ContentSearchSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` @@ -8255,6 +8303,361 @@ func (c *LocationsWidgetSearchCall) Do(opts ...googleapi.CallOption) (*GoogleClo } +// method id "discoveryengine.projects.locations.collections.dataConnector.operations.get": + +type ProjectsLocationsCollectionsDataConnectorOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets the latest state of a long-running operation. Clients can +// use this method to poll the operation result at intervals as +// recommended by the API service. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsDataConnectorOperationsService) Get(name string) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c := &ProjectsLocationsCollectionsDataConnectorOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataConnector.operations.get" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "discoveryengine.projects.locations.collections.dataConnector.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1alpha/{+name}", + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "discoveryengine.projects.locations.collections.dataConnector.operations.list": + +type ProjectsLocationsCollectionsDataConnectorOperationsListCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists operations that match the specified filter in the +// request. If the server doesn't support this method, it returns +// `UNIMPLEMENTED`. +// +// - name: The name of the operation's parent resource. +func (r *ProjectsLocationsCollectionsDataConnectorOperationsService) List(name string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c := &ProjectsLocationsCollectionsDataConnectorOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Filter sets the optional parameter "filter": The standard list +// filter. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Filter(filter string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// PageSize sets the optional parameter "pageSize": The standard list +// page size. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": The standard list +// page token. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}/operations") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataConnector.operations.list" call. +// Exactly one of *GoogleLongrunningListOperationsResponse or error will +// be non-nil. Any non-2xx status code is an error. Response headers are +// in either +// *GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if +// a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningListOperationsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations", + // "httpMethod": "GET", + // "id": "discoveryengine.projects.locations.collections.dataConnector.operations.list", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "filter": { + // "description": "The standard list filter.", + // "location": "query", + // "type": "string" + // }, + // "name": { + // "description": "The name of the operation's parent resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + // "required": true, + // "type": "string" + // }, + // "pageSize": { + // "description": "The standard list page size.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "The standard list page token.", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1alpha/{+name}/operations", + // "response": { + // "$ref": "GoogleLongrunningListOperationsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + // method id "discoveryengine.projects.locations.collections.dataStores.completeQuery": type ProjectsLocationsCollectionsDataStoresCompleteQueryCall struct { @@ -15687,13 +16090,13 @@ func (c *ProjectsLocationsCollectionsEnginesDeleteCall) doRequest(alt string) (* } // Do executes the "discoveryengine.projects.locations.collections.engines.delete" call. -// Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any -// non-2xx status code is an error. Response headers are in either -// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was -// returned at all) in error.(*googleapi.Error).Header. Use +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use // googleapi.IsNotModified to check whether the returned error was // because http.StatusNotModified was returned. -func (c *ProjectsLocationsCollectionsEnginesDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) { +func (c *ProjectsLocationsCollectionsEnginesDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { gensupport.SetOptions(c.urlParams_, opts...) res, err := c.doRequest("json") if res != nil && res.StatusCode == http.StatusNotModified { @@ -15712,7 +16115,7 @@ func (c *ProjectsLocationsCollectionsEnginesDeleteCall) Do(opts ...googleapi.Cal if err := googleapi.CheckResponse(res); err != nil { return nil, gensupport.WrapError(err) } - ret := &GoogleProtobufEmpty{ + ret := &GoogleLongrunningOperation{ ServerResponse: googleapi.ServerResponse{ Header: res.Header, HTTPStatusCode: res.StatusCode, @@ -15742,7 +16145,7 @@ func (c *ProjectsLocationsCollectionsEnginesDeleteCall) Do(opts ...googleapi.Cal // }, // "path": "v1alpha/{+name}", // "response": { - // "$ref": "GoogleProtobufEmpty" + // "$ref": "GoogleLongrunningOperation" // }, // "scopes": [ // "https://www.googleapis.com/auth/cloud-platform" diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index b39814e96c8..02981bbab09 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -111,6 +111,80 @@ "resources": { "collections": { "resources": { + "dataConnector": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataConnector.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataConnector.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "dataStores": { "methods": { "completeQuery": { @@ -2658,7 +2732,7 @@ } } }, - "revision": "20231102", + "revision": "20231110", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3249,6 +3323,20 @@ "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical." + ], + "type": "string" + }, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -3301,17 +3389,17 @@ "properties": { "agentCreationConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using GetEngine or ListEngine API after engine creation." + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using GetEngine or ListEngine API after engine creation. Please use Engine.chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.", + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using GetEngine or ListEngine API after engine creation.", + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { "business": { @@ -5131,6 +5219,10 @@ "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", + "type": "string" + }, "contentSearchSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index df1d71a63ca..ec7ec53de66 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -186,6 +186,7 @@ type ProjectsLocationsService struct { func NewProjectsLocationsCollectionsService(s *Service) *ProjectsLocationsCollectionsService { rs := &ProjectsLocationsCollectionsService{s: s} + rs.DataConnector = NewProjectsLocationsCollectionsDataConnectorService(s) rs.DataStores = NewProjectsLocationsCollectionsDataStoresService(s) rs.Engines = NewProjectsLocationsCollectionsEnginesService(s) rs.Operations = NewProjectsLocationsCollectionsOperationsService(s) @@ -195,6 +196,8 @@ func NewProjectsLocationsCollectionsService(s *Service) *ProjectsLocationsCollec type ProjectsLocationsCollectionsService struct { s *Service + DataConnector *ProjectsLocationsCollectionsDataConnectorService + DataStores *ProjectsLocationsCollectionsDataStoresService Engines *ProjectsLocationsCollectionsEnginesService @@ -202,6 +205,27 @@ type ProjectsLocationsCollectionsService struct { Operations *ProjectsLocationsCollectionsOperationsService } +func NewProjectsLocationsCollectionsDataConnectorService(s *Service) *ProjectsLocationsCollectionsDataConnectorService { + rs := &ProjectsLocationsCollectionsDataConnectorService{s: s} + rs.Operations = NewProjectsLocationsCollectionsDataConnectorOperationsService(s) + return rs +} + +type ProjectsLocationsCollectionsDataConnectorService struct { + s *Service + + Operations *ProjectsLocationsCollectionsDataConnectorOperationsService +} + +func NewProjectsLocationsCollectionsDataConnectorOperationsService(s *Service) *ProjectsLocationsCollectionsDataConnectorOperationsService { + rs := &ProjectsLocationsCollectionsDataConnectorOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsDataConnectorOperationsService struct { + s *Service +} + func NewProjectsLocationsCollectionsDataStoresService(s *Service) *ProjectsLocationsCollectionsDataStoresService { rs := &ProjectsLocationsCollectionsDataStoresService{s: s} rs.Branches = NewProjectsLocationsCollectionsDataStoresBranchesService(s) @@ -1609,6 +1633,18 @@ type GoogleCloudDiscoveryengineV1alphaEngine struct { // human readable. UTF-8 encoded string with limit of 1024 characters. DisplayName string `json:"displayName,omitempty"` + // IndustryVertical: The industry vertical that the engine registers. + // The restriction of the Engine industry vertical is based on + // DataStore: If unspecified, default to `GENERIC`. Vertical on Engine + // has to match vertical of the DataStore liniked to the engine. + // + // Possible values: + // "INDUSTRY_VERTICAL_UNSPECIFIED" - Value used when unset. + // "GENERIC" - The generic vertical for documents that are not + // specific to any industry vertical. + // "MEDIA" - The media industry vertical. + IndustryVertical string `json:"industryVertical,omitempty"` + // MediaRecommendationEngineConfig: Configurations for the Media Engine. // Only applicable on the data stores with solution_type // SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. @@ -1680,8 +1716,8 @@ type GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig struct { // AgentCreationConfig: The configurationt generate the Dialogflow agent // that is associated to this Engine. Note that these configurations are // one-time consumed by and passed to Dialogflow service. It means they - // cannot be retrieved using GetEngine or ListEngine API after engine - // creation. + // cannot be retrieved using EngineService.GetEngine or + // EngineService.ListEngines API after engine creation. AgentCreationConfig *GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig `json:"agentCreationConfig,omitempty"` // DialogflowAgentToLink: The resource name of an exist Dialogflow agent @@ -1690,10 +1726,10 @@ type GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig struct { // links the agent with the Chat engine. Format: // `projects//locations//agents/`. Note that the // `dialogflow_agent_to_link` are one-time consumed by and passed to - // Dialogflow service. It means they cannot be retrieved using GetEngine - // or ListEngine API after engine creation. Please use - // Engine.chat_engine_metadata.dialogflow_agent for actual agent - // association after Engine is created. + // Dialogflow service. It means they cannot be retrieved using + // EngineService.GetEngine or EngineService.ListEngines API after engine + // creation. Please use chat_engine_metadata.dialogflow_agent for actual + // agent association after Engine is created. DialogflowAgentToLink string `json:"dialogflowAgentToLink,omitempty"` // ForceSendFields is a list of field names (e.g. "AgentCreationConfig") @@ -1723,8 +1759,9 @@ func (s *GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig) MarshalJSON() // GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationCo // nfig: Configurations for generating a Dialogflow agent. Note that // these configurations are one-time consumed by and passed to -// Dialogflow service. It means they cannot be retrieved using GetEngine -// or ListEngine API after engine creation. +// Dialogflow service. It means they cannot be retrieved using +// EngineService.GetEngine or EngineService.ListEngines API after engine +// creation. type GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig struct { // Business: Name of the company, organization or other entity that the // agent represents. Used for knowledge connector LLM prompt and for @@ -4982,6 +5019,17 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // branch. Branch string `json:"branch,omitempty"` + // CanonicalFilter: The default filter that is applied when a user + // performs a search without checking any filters on the search page. + // The filter applied to every search request when quality improvement + // such as query expansion is needed. In the case a query does not have + // a sufficient amount of results this filter will be used to determine + // whether or not to enable the query expansion flow. The original + // filter will still be used for the query expanded search. This field + // is strongly recommended to achieve high search quality. For more + // information about filter syntax, see SearchRequest.filter. + CanonicalFilter string `json:"canonicalFilter,omitempty"` + // ContentSearchSpec: A specification for configuring the behavior of // content search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` @@ -6795,6 +6843,361 @@ func (s *GoogleTypeDate) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// method id "discoveryengine.projects.locations.collections.dataConnector.operations.get": + +type ProjectsLocationsCollectionsDataConnectorOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets the latest state of a long-running operation. Clients can +// use this method to poll the operation result at intervals as +// recommended by the API service. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsDataConnectorOperationsService) Get(name string) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c := &ProjectsLocationsCollectionsDataConnectorOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataConnectorOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataConnector.operations.get" call. +// Exactly one of *GoogleLongrunningOperation or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "discoveryengine.projects.locations.collections.dataConnector.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta/{+name}", + // "response": { + // "$ref": "GoogleLongrunningOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "discoveryengine.projects.locations.collections.dataConnector.operations.list": + +type ProjectsLocationsCollectionsDataConnectorOperationsListCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists operations that match the specified filter in the +// request. If the server doesn't support this method, it returns +// `UNIMPLEMENTED`. +// +// - name: The name of the operation's parent resource. +func (r *ProjectsLocationsCollectionsDataConnectorOperationsService) List(name string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c := &ProjectsLocationsCollectionsDataConnectorOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Filter sets the optional parameter "filter": The standard list +// filter. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Filter(filter string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// PageSize sets the optional parameter "pageSize": The standard list +// page size. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": The standard list +// page token. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}/operations") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataConnector.operations.list" call. +// Exactly one of *GoogleLongrunningListOperationsResponse or error will +// be non-nil. Any non-2xx status code is an error. Response headers are +// in either +// *GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if +// a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningListOperationsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations", + // "httpMethod": "GET", + // "id": "discoveryengine.projects.locations.collections.dataConnector.operations.list", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "filter": { + // "description": "The standard list filter.", + // "location": "query", + // "type": "string" + // }, + // "name": { + // "description": "The name of the operation's parent resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$", + // "required": true, + // "type": "string" + // }, + // "pageSize": { + // "description": "The standard list page size.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "The standard list page token.", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1beta/{+name}/operations", + // "response": { + // "$ref": "GoogleLongrunningListOperationsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + // method id "discoveryengine.projects.locations.collections.dataStores.completeQuery": type ProjectsLocationsCollectionsDataStoresCompleteQueryCall struct { diff --git a/domains/v1/domains-api.json b/domains/v1/domains-api.json index 6ac15014df7..19214ae6160 100644 --- a/domains/v1/domains-api.json +++ b/domains/v1/domains-api.json @@ -334,7 +334,7 @@ ] }, "delete": { - "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}", "httpMethod": "DELETE", "id": "domains.projects.locations.registrations.delete", @@ -359,7 +359,8 @@ ] }, "export": { - "description": "Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export", "httpMethod": "POST", "id": "domains.projects.locations.registrations.export", @@ -443,7 +444,8 @@ ] }, "import": { - "description": "Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:import", "httpMethod": "POST", "id": "domains.projects.locations.registrations.import", @@ -627,7 +629,8 @@ ] }, "retrieveImportableDomains": { - "description": "Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveImportableDomains", @@ -693,7 +696,8 @@ ] }, "retrieveTransferParameters": { - "description": "Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveTransferParameters", @@ -809,7 +813,8 @@ ] }, "transfer": { - "description": "Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:transfer", "httpMethod": "POST", "id": "domains.projects.locations.registrations.transfer", @@ -843,7 +848,7 @@ } } }, - "revision": "20231018", + "revision": "20231108", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1037,11 +1042,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1094,7 +1105,8 @@ }, "googleDomainsDns": { "$ref": "GoogleDomainsDns", - "description": "The free DNS zone provided by [Google Domains](https://domains.google/)." + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The free DNS zone provided by [Google Domains](https://domains.google/)." } }, "type": "object" @@ -1213,7 +1225,8 @@ "type": "object" }, "ExportRegistrationRequest": { - "description": "Request for the `ExportRegistration` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ExportRegistration` method.", "id": "ExportRegistrationRequest", "properties": {}, "type": "object" @@ -1267,7 +1280,8 @@ "type": "object" }, "GoogleDomainsDns": { - "description": "Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", "id": "GoogleDomainsDns", "properties": { "dsRecords": { @@ -1304,7 +1318,8 @@ "type": "object" }, "ImportDomainRequest": { - "description": "Request for the `ImportDomain` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ImportDomain` method.", "id": "ImportDomainRequest", "properties": { "domainName": { @@ -1413,17 +1428,47 @@ "description": "Defines renewal, billing, and transfer settings for a `Registration`.", "id": "ManagementSettings", "properties": { + "preferredRenewalMethod": { + "description": "Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during resource creation and can only be updated when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.", + "enum": [ + "RENEWAL_METHOD_UNSPECIFIED", + "AUTOMATIC_RENEWAL", + "MANUAL_RENEWAL", + "RENEWAL_DISABLED" + ], + "enumDeprecated": [ + false, + false, + true, + false + ], + "enumDescriptions": [ + "The renewal method is undefined.", + "The domain is automatically renewed each year.", + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) This option was never used. Use RENEWAL_DISABLED instead.", + "The domain won't be renewed and will expire at its expiration time." + ], + "type": "string" + }, "renewalMethod": { - "description": "Output only. The renewal method for this `Registration`.", + "description": "Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.", "enum": [ "RENEWAL_METHOD_UNSPECIFIED", "AUTOMATIC_RENEWAL", - "MANUAL_RENEWAL" + "MANUAL_RENEWAL", + "RENEWAL_DISABLED" + ], + "enumDeprecated": [ + false, + false, + true, + false ], "enumDescriptions": [ "The renewal method is undefined.", - "The domain is automatically renewed each year . To disable automatic renewals, delete the resource by calling `DeleteRegistration` or export it by calling `ExportRegistration`.", - "The domain must be explicitly renewed each year before its `expire_time`. This option is only available when the `Registration` is in state `EXPORTED`. To manage the domain's current billing and renewal settings, go to [Google Domains](https://domains.google/)." + "The domain is automatically renewed each year.", + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) This option was never used. Use RENEWAL_DISABLED instead.", + "The domain won't be renewed and will expire at its expiration time." ], "readOnly": true, "type": "string" @@ -1722,11 +1767,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1740,7 +1791,7 @@ "type": "object" }, "Registration": { - "description": "The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/). First, call `RetrieveImportableDomains` to list domains to which the calling user has sufficient access. Then call `ImportDomain` on any domain names you want to use with Cloud Domains.", + "description": "The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/) (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). First, call `RetrieveImportableDomains` to list domains to which the calling user has sufficient access. Then call `ImportDomain` on any domain names you want to use with Cloud Domains.", "id": "Registration", "properties": { "contactSettings": { @@ -1773,12 +1824,14 @@ "enum": [ "ISSUE_UNSPECIFIED", "CONTACT_SUPPORT", - "UNVERIFIED_EMAIL" + "UNVERIFIED_EMAIL", + "PROBLEM_WITH_BILLING" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", - "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`." + "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", + "Billing account is not in good standing. The domain will not automatically renew at its expiration time unless you resolve problems with your billing account." ], "type": "string" }, @@ -1837,6 +1890,18 @@ "EXPORTED", "EXPIRED" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + false, + false, + false, + false + ], "enumDescriptions": [ "The state is undefined.", "The domain is being registered.", @@ -1844,7 +1909,7 @@ "The domain is being transferred from another registrar to Cloud Domains.", "The attempt to transfer the domain from another registrar to Cloud Domains failed. You can delete resources in this state and retry the transfer.", "The domain is being imported from Google Domains to Cloud Domains.", - "The domain is registered and operational. The domain renews automatically as long as it remains in this state.", + "The domain is registered and operational. The domain renews automatically as long as it remains in this state and the RenewalMethod is set to AUTOMATIC_RENEWAL.", "The domain is suspended and inoperative. For more details, see the `issues` field.", "The domain is no longer managed with Cloud Domains. It may have been transferred to another registrar or exported for management in [Google Domains](https://domains.google/). You can no longer update it with this API, and information shown about it may be stale. Domains in this state are not automatically renewed by Cloud Domains.", "The domain is expired." @@ -1861,11 +1926,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1873,7 +1944,8 @@ "type": "array" }, "transferFailureReason": { - "description": "Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.", + "deprecated": true, + "description": "Output only. Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.", "enum": [ "TRANSFER_FAILURE_REASON_UNSPECIFIED", "TRANSFER_FAILURE_REASON_UNKNOWN", @@ -1913,7 +1985,8 @@ "type": "object" }, "RetrieveImportableDomainsResponse": { - "description": "Response for the `RetrieveImportableDomains` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveImportableDomains` method.", "id": "RetrieveImportableDomainsResponse", "properties": { "domains": { @@ -1942,7 +2015,8 @@ "type": "object" }, "RetrieveTransferParametersResponse": { - "description": "Response for the `RetrieveTransferParameters` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveTransferParameters` method.", "id": "RetrieveTransferParametersResponse", "properties": { "transferParameters": { @@ -2038,7 +2112,8 @@ "type": "object" }, "TransferDomainRequest": { - "description": "Request for the `TransferDomain` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `TransferDomain` method.", "id": "TransferDomainRequest", "properties": { "authorizationCode": { @@ -2076,7 +2151,8 @@ "type": "object" }, "TransferParameters": { - "description": "Parameters required to transfer a domain from another registrar.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Parameters required to transfer a domain from another registrar.", "id": "TransferParameters", "properties": { "currentRegistrar": { @@ -2107,11 +2183,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, diff --git a/domains/v1/domains-gen.go b/domains/v1/domains-gen.go index 9986101053f..60b92b4d191 100644 --- a/domains/v1/domains-gen.go +++ b/domains/v1/domains-gen.go @@ -593,15 +593,20 @@ type ContactSettings struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). Privacy string `json:"privacy,omitempty"` // RegistrantContact: Required. The registrant contact for the @@ -684,7 +689,10 @@ type DnsSettings struct { // Commonly empty. GlueRecords []*GlueRecord `json:"glueRecords,omitempty"` - // GoogleDomainsDns: The free DNS zone provided by Google Domains + // GoogleDomainsDns: Deprecated: For more information, see Cloud Domains + // feature deprecation + // (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) + // The free DNS zone provided by Google Domains // (https://domains.google/). GoogleDomainsDns *GoogleDomainsDns `json:"googleDomainsDns,omitempty"` @@ -837,8 +845,10 @@ func (s *DsRecord) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExportRegistrationRequest: Request for the `ExportRegistration` -// method. +// ExportRegistrationRequest: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `ExportRegistration` method. type ExportRegistrationRequest struct { } @@ -945,10 +955,13 @@ func (s *GlueRecord) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleDomainsDns: Configuration for using the free DNS zone provided -// by Google Domains as a `Registration`'s `dns_provider`. You cannot -// configure the DNS zone itself using the API. To configure the DNS -// zone, go to Google Domains (https://domains.google/). +// GoogleDomainsDns: Deprecated: For more information, see Cloud Domains +// feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Configuration for using the free DNS zone provided by Google Domains +// as a `Registration`'s `dns_provider`. You cannot configure the DNS +// zone itself using the API. To configure the DNS zone, go to Google +// Domains (https://domains.google/). type GoogleDomainsDns struct { // DsRecords: Output only. The list of DS records published for this // domain. The list is automatically populated when `ds_state` is @@ -998,7 +1011,10 @@ func (s *GoogleDomainsDns) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ImportDomainRequest: Request for the `ImportDomain` method. +// ImportDomainRequest: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `ImportDomain` method. type ImportDomainRequest struct { // DomainName: Required. The domain name. Unicode domain names must be // expressed in Punycode format. @@ -1195,19 +1211,53 @@ func (s *Location) MarshalJSON() ([]byte, error) { // ManagementSettings: Defines renewal, billing, and transfer settings // for a `Registration`. type ManagementSettings struct { - // RenewalMethod: Output only. The renewal method for this - // `Registration`. + // PreferredRenewalMethod: Optional. The desired renewal method for this + // `Registration`. The actual `renewal_method` is automatically updated + // to reflect this choice. If unset or equal to + // `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to + // `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during + // resource creation and can only be updated when the `Registration` + // resource has state `ACTIVE` or `SUSPENDED`. When + // `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual + // `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. + // problems with the Billing Account or reported domain abuse. In such + // cases check the `issues` field on the `Registration`. After the + // problem is resolved the `renewal_method` will be automatically + // updated to `preferred_renewal_method` in a few hours. + // + // Possible values: + // "RENEWAL_METHOD_UNSPECIFIED" - The renewal method is undefined. + // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each + // year. + // "MANUAL_RENEWAL" - Deprecated: For more information, see [Cloud + // Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) This option was never used. Use RENEWAL_DISABLED + // instead. + // "RENEWAL_DISABLED" - The domain won't be renewed and will expire at + // its expiration time. + PreferredRenewalMethod string `json:"preferredRenewalMethod,omitempty"` + + // RenewalMethod: Output only. The actual renewal method for this + // `Registration`. When `preferred_renewal_method` is set to + // `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to + // `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account + // or reported domain abuse. In such cases check the `issues` field on + // the `Registration`. After the problem is resolved the + // `renewal_method` will be automatically updated to + // `preferred_renewal_method` in a few hours. // // Possible values: // "RENEWAL_METHOD_UNSPECIFIED" - The renewal method is undefined. - // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each year - // . To disable automatic renewals, delete the resource by calling - // `DeleteRegistration` or export it by calling `ExportRegistration`. - // "MANUAL_RENEWAL" - The domain must be explicitly renewed each year - // before its `expire_time`. This option is only available when the - // `Registration` is in state `EXPORTED`. To manage the domain's current - // billing and renewal settings, go to [Google - // Domains](https://domains.google/). + // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each + // year. + // "MANUAL_RENEWAL" - Deprecated: For more information, see [Cloud + // Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) This option was never used. Use RENEWAL_DISABLED + // instead. + // "RENEWAL_DISABLED" - The domain won't be renewed and will expire at + // its expiration time. RenewalMethod string `json:"renewalMethod,omitempty"` // TransferLockState: Controls whether the domain can be transferred to @@ -1221,20 +1271,22 @@ type ManagementSettings struct { // another registrar. TransferLockState string `json:"transferLockState,omitempty"` - // ForceSendFields is a list of field names (e.g. "RenewalMethod") 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 is a list of field names (e.g. + // "PreferredRenewalMethod") 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. "RenewalMethod") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "PreferredRenewalMethod") + // 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:"-"` } @@ -1728,15 +1780,20 @@ type RegisterParameters struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` // YearlyPrice: Price to register or renew the domain for one year. @@ -1774,16 +1831,21 @@ func (s *RegisterParameters) MarshalJSON() ([]byte, error) { // availability and obtain information like pricing, which is needed to // build a call to `RegisterDomain`. Another way to create a new // `Registration` is to transfer an existing domain from another -// registrar. First, go to the current registrar to unlock the domain -// for transfer and retrieve the domain's transfer authorization code. -// Then call `RetrieveTransferParameters` to confirm that the domain is -// unlocked and to get values needed to build a call to -// `TransferDomain`. Finally, you can create a new `Registration` by -// importing an existing domain managed with Google Domains -// (https://domains.google/). First, call `RetrieveImportableDomains` to -// list domains to which the calling user has sufficient access. Then -// call `ImportDomain` on any domain names you want to use with Cloud -// Domains. +// registrar (Deprecated: For more information, see Cloud Domains +// feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). +// First, go to the current registrar to unlock the domain for transfer +// and retrieve the domain's transfer authorization code. Then call +// `RetrieveTransferParameters` to confirm that the domain is unlocked +// and to get values needed to build a call to `TransferDomain`. +// Finally, you can create a new `Registration` by importing an existing +// domain managed with Google Domains (https://domains.google/) +// (Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). +// First, call `RetrieveImportableDomains` to list domains to which the +// calling user has sufficient access. Then call `ImportDomain` on any +// domain names you want to use with Cloud Domains. type Registration struct { // ContactSettings: Required. Settings for contact information linked to // the `Registration`. You cannot update these with the @@ -1825,6 +1887,9 @@ type Registration struct { // domain is suspended. To resend the verification email, call // ConfigureContactSettings and provide the current // `registrant_contact.email`. + // "PROBLEM_WITH_BILLING" - Billing account is not in good standing. + // The domain will not automatically renew at its expiration time unless + // you resolve problems with your billing account. Issues []string `json:"issues,omitempty"` // Labels: Set of labels associated with the `Registration`. @@ -1879,7 +1944,8 @@ type Registration struct { // "IMPORT_PENDING" - The domain is being imported from Google Domains // to Cloud Domains. // "ACTIVE" - The domain is registered and operational. The domain - // renews automatically as long as it remains in this state. + // renews automatically as long as it remains in this state and the + // RenewalMethod is set to AUTOMATIC_RENEWAL. // "SUSPENDED" - The domain is suspended and inoperative. For more // details, see the `issues` field. // "EXPORTED" - The domain is no longer managed with Cloud Domains. It @@ -1901,19 +1967,27 @@ type Registration struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` - // TransferFailureReason: Output only. The reason the domain transfer - // failed. Only set for domains in TRANSFER_FAILED state. + // TransferFailureReason: Output only. Deprecated: For more information, + // see Cloud Domains feature deprecation + // (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) + // The reason the domain transfer failed. Only set for domains in + // TRANSFER_FAILED state. // // Possible values: // "TRANSFER_FAILURE_REASON_UNSPECIFIED" - Transfer failure @@ -1974,8 +2048,10 @@ func (s *Registration) MarshalJSON() ([]byte, error) { type ResetAuthorizationCodeRequest struct { } -// RetrieveImportableDomainsResponse: Response for the -// `RetrieveImportableDomains` method. +// RetrieveImportableDomainsResponse: Deprecated: For more information, +// see Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Response for the `RetrieveImportableDomains` method. type RetrieveImportableDomainsResponse struct { // Domains: A list of domains that the calling user manages in Google // Domains. @@ -2048,8 +2124,10 @@ func (s *RetrieveRegisterParametersResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RetrieveTransferParametersResponse: Response for the -// `RetrieveTransferParameters` method. +// RetrieveTransferParametersResponse: Deprecated: For more information, +// see Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Response for the `RetrieveTransferParameters` method. type RetrieveTransferParametersResponse struct { // TransferParameters: Parameters to use when calling the // `TransferDomain` method. @@ -2263,7 +2341,10 @@ func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TransferDomainRequest: Request for the `TransferDomain` method. +// TransferDomainRequest: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `TransferDomain` method. type TransferDomainRequest struct { // AuthorizationCode: The domain's transfer authorization code. You can // obtain this from the domain's current registrar. @@ -2321,8 +2402,10 @@ func (s *TransferDomainRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TransferParameters: Parameters required to transfer a domain from -// another registrar. +// TransferParameters: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Parameters required to transfer a domain from another registrar. type TransferParameters struct { // CurrentRegistrar: The registrar that currently manages the domain. CurrentRegistrar string `json:"currentRegistrar,omitempty"` @@ -2348,15 +2431,20 @@ type TransferParameters struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` // TransferLockState: Indicates whether the domain is protected by a @@ -3555,16 +3643,18 @@ type ProjectsLocationsRegistrationsDeleteCall struct { // Delete: Deletes a `Registration` resource. This method works on any // `Registration` resource using Subscription or Commitment billing // (/domains/pricing#billing-models), provided that the resource was -// created at least 1 day in the past. For `Registration` resources -// using Monthly billing (/domains/pricing#billing-models), this method -// works if: * `state` is `EXPORTED` with `expire_time` in the past * -// `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When -// an active registration is successfully deleted, you can continue to -// use the domain in Google Domains (https://domains.google/) until it -// expires. The calling user becomes the domain's sole owner in Google -// Domains, and permissions for the domain are subsequently managed -// there. The domain does not renew automatically unless the new owner -// sets up billing in Google Domains. +// created at least 1 day in the past. When an active registration is +// successfully deleted, you can continue to use the domain in Google +// Domains (https://domains.google/) until it expires. The calling user +// becomes the domain's sole owner in Google Domains, and permissions +// for the domain are subsequently managed there. The domain does not +// renew automatically unless the new owner sets up billing in Google +// Domains. After January 2024 you will only be able to delete +// `Registration` resources when `state` is one of: `EXPORTED`, +// `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// for more details. // // - name: The name of the `Registration` to delete, in the format // `projects/*/locations/*/registrations/*`. @@ -3660,7 +3750,7 @@ func (c *ProjectsLocationsRegistrationsDeleteCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + // "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}", // "httpMethod": "DELETE", // "id": "domains.projects.locations.registrations.delete", @@ -3698,9 +3788,12 @@ type ProjectsLocationsRegistrationsExportCall struct { header_ http.Header } -// Export: Exports a `Registration` resource, such that it is no longer -// managed by Cloud Domains. When an active domain is successfully -// exported, you can continue to use the domain in Google Domains +// Export: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Exports a `Registration` resource, such that it is no longer managed +// by Cloud Domains. When an active domain is successfully exported, you +// can continue to use the domain in Google Domains // (https://domains.google/) until it expires. The calling user becomes // the domain's sole owner in Google Domains, and permissions for the // domain are subsequently managed there. The domain does not renew @@ -3806,7 +3899,8 @@ func (c *ProjectsLocationsRegistrationsExportCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.export", @@ -4169,11 +4263,14 @@ type ProjectsLocationsRegistrationsImportCall struct { header_ http.Header } -// Import: Imports a domain name from Google Domains -// (https://domains.google/) for use in Cloud Domains. To transfer a -// domain from another registrar, use the `TransferDomain` method -// instead. Since individual users can own domains in Google Domains, -// the calling user must have ownership permission on the domain. +// Import: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Imports a domain name from Google Domains (https://domains.google/) +// for use in Cloud Domains. To transfer a domain from another +// registrar, use the `TransferDomain` method instead. Since individual +// users can own domains in Google Domains, the calling user must have +// ownership permission on the domain. // // - parent: The parent resource of the Registration. Must be in the // format `projects/*/locations/*`. @@ -4275,7 +4372,8 @@ func (c *ProjectsLocationsRegistrationsImportCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:import", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.import", @@ -5146,12 +5244,14 @@ type ProjectsLocationsRegistrationsRetrieveImportableDomainsCall struct { header_ http.Header } -// RetrieveImportableDomains: Lists domain names from Google Domains -// (https://domains.google/) that can be imported to Cloud Domains using -// the `ImportDomain` method. Since individual users can own domains in -// Google Domains, the list of domains returned depends on the -// individual user making the call. Domains already managed by Cloud -// Domains are not returned. +// RetrieveImportableDomains: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Lists domain names from Google Domains (https://domains.google/) that +// can be imported to Cloud Domains using the `ImportDomain` method. +// Since individual users can own domains in Google Domains, the list of +// domains returned depends on the individual user making the call. +// Domains already managed by Cloud Domains are not returned. // // - location: The location. Must be in the format // `projects/*/locations/*`. @@ -5276,7 +5376,8 @@ func (c *ProjectsLocationsRegistrationsRetrieveImportableDomainsCall) Do(opts .. } return ret, nil // { - // "description": "Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains", // "httpMethod": "GET", // "id": "domains.projects.locations.registrations.retrieveImportableDomains", @@ -5509,11 +5610,13 @@ type ProjectsLocationsRegistrationsRetrieveTransferParametersCall struct { header_ http.Header } -// RetrieveTransferParameters: Gets parameters needed to transfer a -// domain name from another registrar to Cloud Domains. For domains -// already managed by Google Domains (https://domains.google/), use -// `ImportDomain` instead. Use the returned values to call -// `TransferDomain`. +// RetrieveTransferParameters: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Gets parameters needed to transfer a domain name from another +// registrar to Cloud Domains. For domains already managed by Google +// Domains (https://domains.google/), use `ImportDomain` instead. Use +// the returned values to call `TransferDomain`. // // - location: The location. Must be in the format // `projects/*/locations/*`. @@ -5631,7 +5734,8 @@ func (c *ProjectsLocationsRegistrationsRetrieveTransferParametersCall) Do(opts . } return ret, nil // { - // "description": "Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters", // "httpMethod": "GET", // "id": "domains.projects.locations.registrations.retrieveTransferParameters", @@ -6133,24 +6237,26 @@ type ProjectsLocationsRegistrationsTransferCall struct { header_ http.Header } -// Transfer: Transfers a domain name from another registrar to Cloud -// Domains. For domains already managed by Google Domains -// (https://domains.google/), use `ImportDomain` instead. Before calling -// this method, go to the domain's current registrar to unlock the -// domain for transfer and retrieve the domain's transfer authorization -// code. Then call `RetrieveTransferParameters` to confirm that the -// domain is unlocked and to get values needed to build a call to this -// method. A successful call creates a `Registration` resource in state -// `TRANSFER_PENDING`. It can take several days to complete the transfer -// process. The registrant can often speed up this process by approving -// the transfer through the current registrar, either by clicking a link -// in an email from the registrar or by visiting the registrar's -// website. A few minutes after transfer approval, the resource -// transitions to state `ACTIVE`, indicating that the transfer was -// successful. If the transfer is rejected or the request expires -// without being approved, the resource can end up in state -// `TRANSFER_FAILED`. If transfer fails, you can safely delete the -// resource and retry the transfer. +// Transfer: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Transfers a domain name from another registrar to Cloud Domains. For +// domains already managed by Google Domains (https://domains.google/), +// use `ImportDomain` instead. Before calling this method, go to the +// domain's current registrar to unlock the domain for transfer and +// retrieve the domain's transfer authorization code. Then call +// `RetrieveTransferParameters` to confirm that the domain is unlocked +// and to get values needed to build a call to this method. A successful +// call creates a `Registration` resource in state `TRANSFER_PENDING`. +// It can take several days to complete the transfer process. The +// registrant can often speed up this process by approving the transfer +// through the current registrar, either by clicking a link in an email +// from the registrar or by visiting the registrar's website. A few +// minutes after transfer approval, the resource transitions to state +// `ACTIVE`, indicating that the transfer was successful. If the +// transfer is rejected or the request expires without being approved, +// the resource can end up in state `TRANSFER_FAILED`. If transfer +// fails, you can safely delete the resource and retry the transfer. // // - parent: The parent resource of the `Registration`. Must be in the // format `projects/*/locations/*`. @@ -6252,7 +6358,8 @@ func (c *ProjectsLocationsRegistrationsTransferCall) Do(opts ...googleapi.CallOp } return ret, nil // { - // "description": "Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations:transfer", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.transfer", diff --git a/domains/v1alpha2/domains-api.json b/domains/v1alpha2/domains-api.json index 094ff312a8a..653ba37e2e2 100644 --- a/domains/v1alpha2/domains-api.json +++ b/domains/v1alpha2/domains-api.json @@ -334,7 +334,7 @@ ] }, "delete": { - "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}", "httpMethod": "DELETE", "id": "domains.projects.locations.registrations.delete", @@ -359,7 +359,8 @@ ] }, "export": { - "description": "Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export", "httpMethod": "POST", "id": "domains.projects.locations.registrations.export", @@ -443,7 +444,8 @@ ] }, "import": { - "description": "Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:import", "httpMethod": "POST", "id": "domains.projects.locations.registrations.import", @@ -627,7 +629,8 @@ ] }, "retrieveImportableDomains": { - "description": "Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveImportableDomains", @@ -693,7 +696,8 @@ ] }, "retrieveTransferParameters": { - "description": "Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveTransferParameters", @@ -809,7 +813,8 @@ ] }, "transfer": { - "description": "Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:transfer", "httpMethod": "POST", "id": "domains.projects.locations.registrations.transfer", @@ -843,7 +848,7 @@ } } }, - "revision": "20231018", + "revision": "20231108", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1037,11 +1042,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1094,7 +1105,8 @@ }, "googleDomainsDns": { "$ref": "GoogleDomainsDns", - "description": "The free DNS zone provided by [Google Domains](https://domains.google/)." + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The free DNS zone provided by [Google Domains](https://domains.google/)." } }, "type": "object" @@ -1213,7 +1225,8 @@ "type": "object" }, "ExportRegistrationRequest": { - "description": "Request for the `ExportRegistration` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ExportRegistration` method.", "id": "ExportRegistrationRequest", "properties": {}, "type": "object" @@ -1267,7 +1280,8 @@ "type": "object" }, "GoogleDomainsDns": { - "description": "Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", "id": "GoogleDomainsDns", "properties": { "dsRecords": { @@ -1304,7 +1318,8 @@ "type": "object" }, "ImportDomainRequest": { - "description": "Request for the `ImportDomain` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ImportDomain` method.", "id": "ImportDomainRequest", "properties": { "domainName": { @@ -1413,17 +1428,47 @@ "description": "Defines renewal, billing, and transfer settings for a `Registration`.", "id": "ManagementSettings", "properties": { + "preferredRenewalMethod": { + "description": "Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during resource creation and can only be updated when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.", + "enum": [ + "RENEWAL_METHOD_UNSPECIFIED", + "AUTOMATIC_RENEWAL", + "MANUAL_RENEWAL", + "RENEWAL_DISABLED" + ], + "enumDeprecated": [ + false, + false, + true, + false + ], + "enumDescriptions": [ + "The renewal method is undefined.", + "The domain is automatically renewed each year.", + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) This option was never used. Use RENEWAL_DISABLED instead.", + "The domain won't be renewed and will expire at its expiration time." + ], + "type": "string" + }, "renewalMethod": { - "description": "Output only. The renewal method for this `Registration`.", + "description": "Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.", "enum": [ "RENEWAL_METHOD_UNSPECIFIED", "AUTOMATIC_RENEWAL", - "MANUAL_RENEWAL" + "MANUAL_RENEWAL", + "RENEWAL_DISABLED" + ], + "enumDeprecated": [ + false, + false, + true, + false ], "enumDescriptions": [ "The renewal method is undefined.", - "The domain is automatically renewed each year . To disable automatic renewals, delete the resource by calling `DeleteRegistration` or export it by calling `ExportRegistration`.", - "The domain must be explicitly renewed each year before its `expire_time`. This option is only available when the `Registration` is in state `EXPORTED`. To manage the domain's current billing and renewal settings, go to [Google Domains](https://domains.google/)." + "The domain is automatically renewed each year.", + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) This option was never used. Use RENEWAL_DISABLED instead.", + "The domain won't be renewed and will expire at its expiration time." ], "readOnly": true, "type": "string" @@ -1722,11 +1767,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1740,7 +1791,7 @@ "type": "object" }, "Registration": { - "description": "The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/). First, call `RetrieveImportableDomains` to list domains to which the calling user has sufficient access. Then call `ImportDomain` on any domain names you want to use with Cloud Domains.", + "description": "The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/) (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). First, call `RetrieveImportableDomains` to list domains to which the calling user has sufficient access. Then call `ImportDomain` on any domain names you want to use with Cloud Domains.", "id": "Registration", "properties": { "contactSettings": { @@ -1773,12 +1824,14 @@ "enum": [ "ISSUE_UNSPECIFIED", "CONTACT_SUPPORT", - "UNVERIFIED_EMAIL" + "UNVERIFIED_EMAIL", + "PROBLEM_WITH_BILLING" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", - "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`." + "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", + "Billing account is not in good standing. The domain will not automatically renew at its expiration time unless you resolve problems with your billing account." ], "type": "string" }, @@ -1837,6 +1890,18 @@ "EXPORTED", "EXPIRED" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + false, + false, + false, + false + ], "enumDescriptions": [ "The state is undefined.", "The domain is being registered.", @@ -1844,7 +1909,7 @@ "The domain is being transferred from another registrar to Cloud Domains.", "The attempt to transfer the domain from another registrar to Cloud Domains failed. You can delete resources in this state and retry the transfer.", "The domain is being imported from Google Domains to Cloud Domains.", - "The domain is registered and operational. The domain renews automatically as long as it remains in this state.", + "The domain is registered and operational. The domain renews automatically as long as it remains in this state and the RenewalMethod is set to AUTOMATIC_RENEWAL.", "The domain is suspended and inoperative. For more details, see the `issues` field.", "The domain is no longer managed with Cloud Domains. It may have been transferred to another registrar or exported for management in [Google Domains](https://domains.google/). You can no longer update it with this API, and information shown about it may be stale. Domains in this state are not automatically renewed by Cloud Domains.", "The domain is expired." @@ -1861,11 +1926,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1873,7 +1944,8 @@ "type": "array" }, "transferFailureReason": { - "description": "Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.", + "deprecated": true, + "description": "Output only. Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.", "enum": [ "TRANSFER_FAILURE_REASON_UNSPECIFIED", "TRANSFER_FAILURE_REASON_UNKNOWN", @@ -1913,7 +1985,8 @@ "type": "object" }, "RetrieveImportableDomainsResponse": { - "description": "Response for the `RetrieveImportableDomains` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveImportableDomains` method.", "id": "RetrieveImportableDomainsResponse", "properties": { "domains": { @@ -1942,7 +2015,8 @@ "type": "object" }, "RetrieveTransferParametersResponse": { - "description": "Response for the `RetrieveTransferParameters` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveTransferParameters` method.", "id": "RetrieveTransferParametersResponse", "properties": { "transferParameters": { @@ -2038,7 +2112,8 @@ "type": "object" }, "TransferDomainRequest": { - "description": "Request for the `TransferDomain` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `TransferDomain` method.", "id": "TransferDomainRequest", "properties": { "authorizationCode": { @@ -2076,7 +2151,8 @@ "type": "object" }, "TransferParameters": { - "description": "Parameters required to transfer a domain from another registrar.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Parameters required to transfer a domain from another registrar.", "id": "TransferParameters", "properties": { "currentRegistrar": { @@ -2107,11 +2183,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, diff --git a/domains/v1alpha2/domains-gen.go b/domains/v1alpha2/domains-gen.go index 36d6b712aaa..912b639c7e4 100644 --- a/domains/v1alpha2/domains-gen.go +++ b/domains/v1alpha2/domains-gen.go @@ -593,15 +593,20 @@ type ContactSettings struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). Privacy string `json:"privacy,omitempty"` // RegistrantContact: Required. The registrant contact for the @@ -684,7 +689,10 @@ type DnsSettings struct { // Commonly empty. GlueRecords []*GlueRecord `json:"glueRecords,omitempty"` - // GoogleDomainsDns: The free DNS zone provided by Google Domains + // GoogleDomainsDns: Deprecated: For more information, see Cloud Domains + // feature deprecation + // (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) + // The free DNS zone provided by Google Domains // (https://domains.google/). GoogleDomainsDns *GoogleDomainsDns `json:"googleDomainsDns,omitempty"` @@ -837,8 +845,10 @@ func (s *DsRecord) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExportRegistrationRequest: Request for the `ExportRegistration` -// method. +// ExportRegistrationRequest: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `ExportRegistration` method. type ExportRegistrationRequest struct { } @@ -945,10 +955,13 @@ func (s *GlueRecord) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleDomainsDns: Configuration for using the free DNS zone provided -// by Google Domains as a `Registration`'s `dns_provider`. You cannot -// configure the DNS zone itself using the API. To configure the DNS -// zone, go to Google Domains (https://domains.google/). +// GoogleDomainsDns: Deprecated: For more information, see Cloud Domains +// feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Configuration for using the free DNS zone provided by Google Domains +// as a `Registration`'s `dns_provider`. You cannot configure the DNS +// zone itself using the API. To configure the DNS zone, go to Google +// Domains (https://domains.google/). type GoogleDomainsDns struct { // DsRecords: Output only. The list of DS records published for this // domain. The list is automatically populated when `ds_state` is @@ -998,7 +1011,10 @@ func (s *GoogleDomainsDns) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ImportDomainRequest: Request for the `ImportDomain` method. +// ImportDomainRequest: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `ImportDomain` method. type ImportDomainRequest struct { // DomainName: Required. The domain name. Unicode domain names must be // expressed in Punycode format. @@ -1195,19 +1211,53 @@ func (s *Location) MarshalJSON() ([]byte, error) { // ManagementSettings: Defines renewal, billing, and transfer settings // for a `Registration`. type ManagementSettings struct { - // RenewalMethod: Output only. The renewal method for this - // `Registration`. + // PreferredRenewalMethod: Optional. The desired renewal method for this + // `Registration`. The actual `renewal_method` is automatically updated + // to reflect this choice. If unset or equal to + // `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to + // `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during + // resource creation and can only be updated when the `Registration` + // resource has state `ACTIVE` or `SUSPENDED`. When + // `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual + // `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. + // problems with the Billing Account or reported domain abuse. In such + // cases check the `issues` field on the `Registration`. After the + // problem is resolved the `renewal_method` will be automatically + // updated to `preferred_renewal_method` in a few hours. + // + // Possible values: + // "RENEWAL_METHOD_UNSPECIFIED" - The renewal method is undefined. + // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each + // year. + // "MANUAL_RENEWAL" - Deprecated: For more information, see [Cloud + // Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) This option was never used. Use RENEWAL_DISABLED + // instead. + // "RENEWAL_DISABLED" - The domain won't be renewed and will expire at + // its expiration time. + PreferredRenewalMethod string `json:"preferredRenewalMethod,omitempty"` + + // RenewalMethod: Output only. The actual renewal method for this + // `Registration`. When `preferred_renewal_method` is set to + // `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to + // `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account + // or reported domain abuse. In such cases check the `issues` field on + // the `Registration`. After the problem is resolved the + // `renewal_method` will be automatically updated to + // `preferred_renewal_method` in a few hours. // // Possible values: // "RENEWAL_METHOD_UNSPECIFIED" - The renewal method is undefined. - // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each year - // . To disable automatic renewals, delete the resource by calling - // `DeleteRegistration` or export it by calling `ExportRegistration`. - // "MANUAL_RENEWAL" - The domain must be explicitly renewed each year - // before its `expire_time`. This option is only available when the - // `Registration` is in state `EXPORTED`. To manage the domain's current - // billing and renewal settings, go to [Google - // Domains](https://domains.google/). + // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each + // year. + // "MANUAL_RENEWAL" - Deprecated: For more information, see [Cloud + // Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) This option was never used. Use RENEWAL_DISABLED + // instead. + // "RENEWAL_DISABLED" - The domain won't be renewed and will expire at + // its expiration time. RenewalMethod string `json:"renewalMethod,omitempty"` // TransferLockState: Controls whether the domain can be transferred to @@ -1221,20 +1271,22 @@ type ManagementSettings struct { // another registrar. TransferLockState string `json:"transferLockState,omitempty"` - // ForceSendFields is a list of field names (e.g. "RenewalMethod") 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 is a list of field names (e.g. + // "PreferredRenewalMethod") 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. "RenewalMethod") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "PreferredRenewalMethod") + // 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:"-"` } @@ -1728,15 +1780,20 @@ type RegisterParameters struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` // YearlyPrice: Price to register or renew the domain for one year. @@ -1774,16 +1831,21 @@ func (s *RegisterParameters) MarshalJSON() ([]byte, error) { // availability and obtain information like pricing, which is needed to // build a call to `RegisterDomain`. Another way to create a new // `Registration` is to transfer an existing domain from another -// registrar. First, go to the current registrar to unlock the domain -// for transfer and retrieve the domain's transfer authorization code. -// Then call `RetrieveTransferParameters` to confirm that the domain is -// unlocked and to get values needed to build a call to -// `TransferDomain`. Finally, you can create a new `Registration` by -// importing an existing domain managed with Google Domains -// (https://domains.google/). First, call `RetrieveImportableDomains` to -// list domains to which the calling user has sufficient access. Then -// call `ImportDomain` on any domain names you want to use with Cloud -// Domains. +// registrar (Deprecated: For more information, see Cloud Domains +// feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). +// First, go to the current registrar to unlock the domain for transfer +// and retrieve the domain's transfer authorization code. Then call +// `RetrieveTransferParameters` to confirm that the domain is unlocked +// and to get values needed to build a call to `TransferDomain`. +// Finally, you can create a new `Registration` by importing an existing +// domain managed with Google Domains (https://domains.google/) +// (Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). +// First, call `RetrieveImportableDomains` to list domains to which the +// calling user has sufficient access. Then call `ImportDomain` on any +// domain names you want to use with Cloud Domains. type Registration struct { // ContactSettings: Required. Settings for contact information linked to // the `Registration`. You cannot update these with the @@ -1825,6 +1887,9 @@ type Registration struct { // domain is suspended. To resend the verification email, call // ConfigureContactSettings and provide the current // `registrant_contact.email`. + // "PROBLEM_WITH_BILLING" - Billing account is not in good standing. + // The domain will not automatically renew at its expiration time unless + // you resolve problems with your billing account. Issues []string `json:"issues,omitempty"` // Labels: Set of labels associated with the `Registration`. @@ -1879,7 +1944,8 @@ type Registration struct { // "IMPORT_PENDING" - The domain is being imported from Google Domains // to Cloud Domains. // "ACTIVE" - The domain is registered and operational. The domain - // renews automatically as long as it remains in this state. + // renews automatically as long as it remains in this state and the + // RenewalMethod is set to AUTOMATIC_RENEWAL. // "SUSPENDED" - The domain is suspended and inoperative. For more // details, see the `issues` field. // "EXPORTED" - The domain is no longer managed with Cloud Domains. It @@ -1901,19 +1967,27 @@ type Registration struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` - // TransferFailureReason: Output only. The reason the domain transfer - // failed. Only set for domains in TRANSFER_FAILED state. + // TransferFailureReason: Output only. Deprecated: For more information, + // see Cloud Domains feature deprecation + // (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) + // The reason the domain transfer failed. Only set for domains in + // TRANSFER_FAILED state. // // Possible values: // "TRANSFER_FAILURE_REASON_UNSPECIFIED" - Transfer failure @@ -1974,8 +2048,10 @@ func (s *Registration) MarshalJSON() ([]byte, error) { type ResetAuthorizationCodeRequest struct { } -// RetrieveImportableDomainsResponse: Response for the -// `RetrieveImportableDomains` method. +// RetrieveImportableDomainsResponse: Deprecated: For more information, +// see Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Response for the `RetrieveImportableDomains` method. type RetrieveImportableDomainsResponse struct { // Domains: A list of domains that the calling user manages in Google // Domains. @@ -2048,8 +2124,10 @@ func (s *RetrieveRegisterParametersResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RetrieveTransferParametersResponse: Response for the -// `RetrieveTransferParameters` method. +// RetrieveTransferParametersResponse: Deprecated: For more information, +// see Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Response for the `RetrieveTransferParameters` method. type RetrieveTransferParametersResponse struct { // TransferParameters: Parameters to use when calling the // `TransferDomain` method. @@ -2263,7 +2341,10 @@ func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TransferDomainRequest: Request for the `TransferDomain` method. +// TransferDomainRequest: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `TransferDomain` method. type TransferDomainRequest struct { // AuthorizationCode: The domain's transfer authorization code. You can // obtain this from the domain's current registrar. @@ -2321,8 +2402,10 @@ func (s *TransferDomainRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TransferParameters: Parameters required to transfer a domain from -// another registrar. +// TransferParameters: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Parameters required to transfer a domain from another registrar. type TransferParameters struct { // CurrentRegistrar: The registrar that currently manages the domain. CurrentRegistrar string `json:"currentRegistrar,omitempty"` @@ -2348,15 +2431,20 @@ type TransferParameters struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` // TransferLockState: Indicates whether the domain is protected by a @@ -3555,16 +3643,18 @@ type ProjectsLocationsRegistrationsDeleteCall struct { // Delete: Deletes a `Registration` resource. This method works on any // `Registration` resource using Subscription or Commitment billing // (/domains/pricing#billing-models), provided that the resource was -// created at least 1 day in the past. For `Registration` resources -// using Monthly billing (/domains/pricing#billing-models), this method -// works if: * `state` is `EXPORTED` with `expire_time` in the past * -// `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When -// an active registration is successfully deleted, you can continue to -// use the domain in Google Domains (https://domains.google/) until it -// expires. The calling user becomes the domain's sole owner in Google -// Domains, and permissions for the domain are subsequently managed -// there. The domain does not renew automatically unless the new owner -// sets up billing in Google Domains. +// created at least 1 day in the past. When an active registration is +// successfully deleted, you can continue to use the domain in Google +// Domains (https://domains.google/) until it expires. The calling user +// becomes the domain's sole owner in Google Domains, and permissions +// for the domain are subsequently managed there. The domain does not +// renew automatically unless the new owner sets up billing in Google +// Domains. After January 2024 you will only be able to delete +// `Registration` resources when `state` is one of: `EXPORTED`, +// `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// for more details. // // - name: The name of the `Registration` to delete, in the format // `projects/*/locations/*/registrations/*`. @@ -3660,7 +3750,7 @@ func (c *ProjectsLocationsRegistrationsDeleteCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + // "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.", // "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}", // "httpMethod": "DELETE", // "id": "domains.projects.locations.registrations.delete", @@ -3698,9 +3788,12 @@ type ProjectsLocationsRegistrationsExportCall struct { header_ http.Header } -// Export: Exports a `Registration` resource, such that it is no longer -// managed by Cloud Domains. When an active domain is successfully -// exported, you can continue to use the domain in Google Domains +// Export: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Exports a `Registration` resource, such that it is no longer managed +// by Cloud Domains. When an active domain is successfully exported, you +// can continue to use the domain in Google Domains // (https://domains.google/) until it expires. The calling user becomes // the domain's sole owner in Google Domains, and permissions for the // domain are subsequently managed there. The domain does not renew @@ -3806,7 +3899,8 @@ func (c *ProjectsLocationsRegistrationsExportCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", // "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.export", @@ -4169,11 +4263,14 @@ type ProjectsLocationsRegistrationsImportCall struct { header_ http.Header } -// Import: Imports a domain name from Google Domains -// (https://domains.google/) for use in Cloud Domains. To transfer a -// domain from another registrar, use the `TransferDomain` method -// instead. Since individual users can own domains in Google Domains, -// the calling user must have ownership permission on the domain. +// Import: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Imports a domain name from Google Domains (https://domains.google/) +// for use in Cloud Domains. To transfer a domain from another +// registrar, use the `TransferDomain` method instead. Since individual +// users can own domains in Google Domains, the calling user must have +// ownership permission on the domain. // // - parent: The parent resource of the Registration. Must be in the // format `projects/*/locations/*`. @@ -4275,7 +4372,8 @@ func (c *ProjectsLocationsRegistrationsImportCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", // "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:import", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.import", @@ -5146,12 +5244,14 @@ type ProjectsLocationsRegistrationsRetrieveImportableDomainsCall struct { header_ http.Header } -// RetrieveImportableDomains: Lists domain names from Google Domains -// (https://domains.google/) that can be imported to Cloud Domains using -// the `ImportDomain` method. Since individual users can own domains in -// Google Domains, the list of domains returned depends on the -// individual user making the call. Domains already managed by Cloud -// Domains are not returned. +// RetrieveImportableDomains: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Lists domain names from Google Domains (https://domains.google/) that +// can be imported to Cloud Domains using the `ImportDomain` method. +// Since individual users can own domains in Google Domains, the list of +// domains returned depends on the individual user making the call. +// Domains already managed by Cloud Domains are not returned. // // - location: The location. Must be in the format // `projects/*/locations/*`. @@ -5276,7 +5376,8 @@ func (c *ProjectsLocationsRegistrationsRetrieveImportableDomainsCall) Do(opts .. } return ret, nil // { - // "description": "Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", // "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains", // "httpMethod": "GET", // "id": "domains.projects.locations.registrations.retrieveImportableDomains", @@ -5509,11 +5610,13 @@ type ProjectsLocationsRegistrationsRetrieveTransferParametersCall struct { header_ http.Header } -// RetrieveTransferParameters: Gets parameters needed to transfer a -// domain name from another registrar to Cloud Domains. For domains -// already managed by Google Domains (https://domains.google/), use -// `ImportDomain` instead. Use the returned values to call -// `TransferDomain`. +// RetrieveTransferParameters: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Gets parameters needed to transfer a domain name from another +// registrar to Cloud Domains. For domains already managed by Google +// Domains (https://domains.google/), use `ImportDomain` instead. Use +// the returned values to call `TransferDomain`. // // - location: The location. Must be in the format // `projects/*/locations/*`. @@ -5631,7 +5734,8 @@ func (c *ProjectsLocationsRegistrationsRetrieveTransferParametersCall) Do(opts . } return ret, nil // { - // "description": "Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", // "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters", // "httpMethod": "GET", // "id": "domains.projects.locations.registrations.retrieveTransferParameters", @@ -6133,24 +6237,26 @@ type ProjectsLocationsRegistrationsTransferCall struct { header_ http.Header } -// Transfer: Transfers a domain name from another registrar to Cloud -// Domains. For domains already managed by Google Domains -// (https://domains.google/), use `ImportDomain` instead. Before calling -// this method, go to the domain's current registrar to unlock the -// domain for transfer and retrieve the domain's transfer authorization -// code. Then call `RetrieveTransferParameters` to confirm that the -// domain is unlocked and to get values needed to build a call to this -// method. A successful call creates a `Registration` resource in state -// `TRANSFER_PENDING`. It can take several days to complete the transfer -// process. The registrant can often speed up this process by approving -// the transfer through the current registrar, either by clicking a link -// in an email from the registrar or by visiting the registrar's -// website. A few minutes after transfer approval, the resource -// transitions to state `ACTIVE`, indicating that the transfer was -// successful. If the transfer is rejected or the request expires -// without being approved, the resource can end up in state -// `TRANSFER_FAILED`. If transfer fails, you can safely delete the -// resource and retry the transfer. +// Transfer: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Transfers a domain name from another registrar to Cloud Domains. For +// domains already managed by Google Domains (https://domains.google/), +// use `ImportDomain` instead. Before calling this method, go to the +// domain's current registrar to unlock the domain for transfer and +// retrieve the domain's transfer authorization code. Then call +// `RetrieveTransferParameters` to confirm that the domain is unlocked +// and to get values needed to build a call to this method. A successful +// call creates a `Registration` resource in state `TRANSFER_PENDING`. +// It can take several days to complete the transfer process. The +// registrant can often speed up this process by approving the transfer +// through the current registrar, either by clicking a link in an email +// from the registrar or by visiting the registrar's website. A few +// minutes after transfer approval, the resource transitions to state +// `ACTIVE`, indicating that the transfer was successful. If the +// transfer is rejected or the request expires without being approved, +// the resource can end up in state `TRANSFER_FAILED`. If transfer +// fails, you can safely delete the resource and retry the transfer. // // - parent: The parent resource of the `Registration`. Must be in the // format `projects/*/locations/*`. @@ -6252,7 +6358,8 @@ func (c *ProjectsLocationsRegistrationsTransferCall) Do(opts ...googleapi.CallOp } return ret, nil // { - // "description": "Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", // "flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/registrations:transfer", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.transfer", diff --git a/domains/v1beta1/domains-api.json b/domains/v1beta1/domains-api.json index 82d46d8c972..9a2b00d9a45 100644 --- a/domains/v1beta1/domains-api.json +++ b/domains/v1beta1/domains-api.json @@ -334,7 +334,7 @@ ] }, "delete": { - "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}", "httpMethod": "DELETE", "id": "domains.projects.locations.registrations.delete", @@ -359,7 +359,8 @@ ] }, "export": { - "description": "Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export", "httpMethod": "POST", "id": "domains.projects.locations.registrations.export", @@ -443,7 +444,8 @@ ] }, "import": { - "description": "Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:import", "httpMethod": "POST", "id": "domains.projects.locations.registrations.import", @@ -627,7 +629,8 @@ ] }, "retrieveImportableDomains": { - "description": "Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveImportableDomains", @@ -693,7 +696,8 @@ ] }, "retrieveTransferParameters": { - "description": "Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters", "httpMethod": "GET", "id": "domains.projects.locations.registrations.retrieveTransferParameters", @@ -809,7 +813,8 @@ ] }, "transfer": { - "description": "Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:transfer", "httpMethod": "POST", "id": "domains.projects.locations.registrations.transfer", @@ -843,7 +848,7 @@ } } }, - "revision": "20231018", + "revision": "20231108", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1037,11 +1042,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1094,7 +1105,8 @@ }, "googleDomainsDns": { "$ref": "GoogleDomainsDns", - "description": "The free DNS zone provided by [Google Domains](https://domains.google/)." + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The free DNS zone provided by [Google Domains](https://domains.google/)." } }, "type": "object" @@ -1213,7 +1225,8 @@ "type": "object" }, "ExportRegistrationRequest": { - "description": "Request for the `ExportRegistration` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ExportRegistration` method.", "id": "ExportRegistrationRequest", "properties": {}, "type": "object" @@ -1267,7 +1280,8 @@ "type": "object" }, "GoogleDomainsDns": { - "description": "Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", "id": "GoogleDomainsDns", "properties": { "dsRecords": { @@ -1304,7 +1318,8 @@ "type": "object" }, "ImportDomainRequest": { - "description": "Request for the `ImportDomain` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `ImportDomain` method.", "id": "ImportDomainRequest", "properties": { "domainName": { @@ -1413,17 +1428,47 @@ "description": "Defines renewal, billing, and transfer settings for a `Registration`.", "id": "ManagementSettings", "properties": { + "preferredRenewalMethod": { + "description": "Optional. The desired renewal method for this `Registration`. The actual `renewal_method` is automatically updated to reflect this choice. If unset or equal to `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during resource creation and can only be updated when the `Registration` resource has state `ACTIVE` or `SUSPENDED`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.", + "enum": [ + "RENEWAL_METHOD_UNSPECIFIED", + "AUTOMATIC_RENEWAL", + "MANUAL_RENEWAL", + "RENEWAL_DISABLED" + ], + "enumDeprecated": [ + false, + false, + true, + false + ], + "enumDescriptions": [ + "The renewal method is undefined.", + "The domain is automatically renewed each year.", + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) This option was never used. Use RENEWAL_DISABLED instead.", + "The domain won't be renewed and will expire at its expiration time." + ], + "type": "string" + }, "renewalMethod": { - "description": "Output only. The renewal method for this `Registration`.", + "description": "Output only. The actual renewal method for this `Registration`. When `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the `issues` field on the `Registration`. After the problem is resolved the `renewal_method` will be automatically updated to `preferred_renewal_method` in a few hours.", "enum": [ "RENEWAL_METHOD_UNSPECIFIED", "AUTOMATIC_RENEWAL", - "MANUAL_RENEWAL" + "MANUAL_RENEWAL", + "RENEWAL_DISABLED" + ], + "enumDeprecated": [ + false, + false, + true, + false ], "enumDescriptions": [ "The renewal method is undefined.", - "The domain is automatically renewed each year . To disable automatic renewals, delete the resource by calling `DeleteRegistration` or export it by calling `ExportRegistration`.", - "The domain must be explicitly renewed each year before its `expire_time`. This option is only available when the `Registration` is in state `EXPORTED`. To manage the domain's current billing and renewal settings, go to [Google Domains](https://domains.google/)." + "The domain is automatically renewed each year.", + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) This option was never used. Use RENEWAL_DISABLED instead.", + "The domain won't be renewed and will expire at its expiration time." ], "readOnly": true, "type": "string" @@ -1722,11 +1767,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1740,7 +1791,7 @@ "type": "object" }, "Registration": { - "description": "The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/). First, call `RetrieveImportableDomains` to list domains to which the calling user has sufficient access. Then call `ImportDomain` on any domain names you want to use with Cloud Domains.", + "description": "The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. Finally, you can create a new `Registration` by importing an existing domain managed with [Google Domains](https://domains.google/) (Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). First, call `RetrieveImportableDomains` to list domains to which the calling user has sufficient access. Then call `ImportDomain` on any domain names you want to use with Cloud Domains.", "id": "Registration", "properties": { "contactSettings": { @@ -1773,12 +1824,14 @@ "enum": [ "ISSUE_UNSPECIFIED", "CONTACT_SUPPORT", - "UNVERIFIED_EMAIL" + "UNVERIFIED_EMAIL", + "PROBLEM_WITH_BILLING" ], "enumDescriptions": [ "The issue is undefined.", "Contact the Cloud Support team to resolve a problem with this domain.", - "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`." + "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.", + "Billing account is not in good standing. The domain will not automatically renew at its expiration time unless you resolve problems with your billing account." ], "type": "string" }, @@ -1837,6 +1890,18 @@ "EXPORTED", "EXPIRED" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + false, + false, + false, + false + ], "enumDescriptions": [ "The state is undefined.", "The domain is being registered.", @@ -1844,7 +1909,7 @@ "The domain is being transferred from another registrar to Cloud Domains.", "The attempt to transfer the domain from another registrar to Cloud Domains failed. You can delete resources in this state and retry the transfer.", "The domain is being imported from Google Domains to Cloud Domains.", - "The domain is registered and operational. The domain renews automatically as long as it remains in this state.", + "The domain is registered and operational. The domain renews automatically as long as it remains in this state and the RenewalMethod is set to AUTOMATIC_RENEWAL.", "The domain is suspended and inoperative. For more details, see the `issues` field.", "The domain is no longer managed with Cloud Domains. It may have been transferred to another registrar or exported for management in [Google Domains](https://domains.google/). You can no longer update it with this API, and information shown about it may be stale. Domains in this state are not automatically renewed by Cloud Domains.", "The domain is expired." @@ -1861,11 +1926,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, @@ -1873,7 +1944,8 @@ "type": "array" }, "transferFailureReason": { - "description": "Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.", + "deprecated": true, + "description": "Output only. Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.", "enum": [ "TRANSFER_FAILURE_REASON_UNSPECIFIED", "TRANSFER_FAILURE_REASON_UNKNOWN", @@ -1913,7 +1985,8 @@ "type": "object" }, "RetrieveImportableDomainsResponse": { - "description": "Response for the `RetrieveImportableDomains` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveImportableDomains` method.", "id": "RetrieveImportableDomainsResponse", "properties": { "domains": { @@ -1942,7 +2015,8 @@ "type": "object" }, "RetrieveTransferParametersResponse": { - "description": "Response for the `RetrieveTransferParameters` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Response for the `RetrieveTransferParameters` method.", "id": "RetrieveTransferParametersResponse", "properties": { "transferParameters": { @@ -2038,7 +2112,8 @@ "type": "object" }, "TransferDomainRequest": { - "description": "Request for the `TransferDomain` method.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Request for the `TransferDomain` method.", "id": "TransferDomainRequest", "properties": { "authorizationCode": { @@ -2076,7 +2151,8 @@ "type": "object" }, "TransferParameters": { - "description": "Parameters required to transfer a domain from another registrar.", + "deprecated": true, + "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Parameters required to transfer a domain from another registrar.", "id": "TransferParameters", "properties": { "currentRegistrar": { @@ -2107,11 +2183,17 @@ "PRIVATE_CONTACT_DATA", "REDACTED_CONTACT_DATA" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "The contact privacy settings are undefined.", "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", - "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", - "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "The organization name (if provided) and limited non-identifying data from `ContactSettings` is available to the public (e.g. country and state). The remaining data is marked as `REDACTED FOR PRIVACY` in the WHOIS database. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." ], "type": "string" }, diff --git a/domains/v1beta1/domains-gen.go b/domains/v1beta1/domains-gen.go index 6a11be6721e..438adbb5929 100644 --- a/domains/v1beta1/domains-gen.go +++ b/domains/v1beta1/domains-gen.go @@ -593,15 +593,20 @@ type ContactSettings struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). Privacy string `json:"privacy,omitempty"` // RegistrantContact: Required. The registrant contact for the @@ -684,7 +689,10 @@ type DnsSettings struct { // Commonly empty. GlueRecords []*GlueRecord `json:"glueRecords,omitempty"` - // GoogleDomainsDns: The free DNS zone provided by Google Domains + // GoogleDomainsDns: Deprecated: For more information, see Cloud Domains + // feature deprecation + // (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) + // The free DNS zone provided by Google Domains // (https://domains.google/). GoogleDomainsDns *GoogleDomainsDns `json:"googleDomainsDns,omitempty"` @@ -837,8 +845,10 @@ func (s *DsRecord) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ExportRegistrationRequest: Request for the `ExportRegistration` -// method. +// ExportRegistrationRequest: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `ExportRegistration` method. type ExportRegistrationRequest struct { } @@ -945,10 +955,13 @@ func (s *GlueRecord) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleDomainsDns: Configuration for using the free DNS zone provided -// by Google Domains as a `Registration`'s `dns_provider`. You cannot -// configure the DNS zone itself using the API. To configure the DNS -// zone, go to Google Domains (https://domains.google/). +// GoogleDomainsDns: Deprecated: For more information, see Cloud Domains +// feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Configuration for using the free DNS zone provided by Google Domains +// as a `Registration`'s `dns_provider`. You cannot configure the DNS +// zone itself using the API. To configure the DNS zone, go to Google +// Domains (https://domains.google/). type GoogleDomainsDns struct { // DsRecords: Output only. The list of DS records published for this // domain. The list is automatically populated when `ds_state` is @@ -998,7 +1011,10 @@ func (s *GoogleDomainsDns) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ImportDomainRequest: Request for the `ImportDomain` method. +// ImportDomainRequest: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `ImportDomain` method. type ImportDomainRequest struct { // DomainName: Required. The domain name. Unicode domain names must be // expressed in Punycode format. @@ -1195,19 +1211,53 @@ func (s *Location) MarshalJSON() ([]byte, error) { // ManagementSettings: Defines renewal, billing, and transfer settings // for a `Registration`. type ManagementSettings struct { - // RenewalMethod: Output only. The renewal method for this - // `Registration`. + // PreferredRenewalMethod: Optional. The desired renewal method for this + // `Registration`. The actual `renewal_method` is automatically updated + // to reflect this choice. If unset or equal to + // `RENEWAL_METHOD_UNSPECIFIED`, it will be treated as if it were set to + // `AUTOMATIC_RENEWAL`. Can't be set to `RENEWAL_DISABLED` during + // resource creation and can only be updated when the `Registration` + // resource has state `ACTIVE` or `SUSPENDED`. When + // `preferred_renewal_method` is set to `AUTOMATIC_RENEWAL` the actual + // `renewal_method` can be set to `RENEWAL_DISABLED` in case of e.g. + // problems with the Billing Account or reported domain abuse. In such + // cases check the `issues` field on the `Registration`. After the + // problem is resolved the `renewal_method` will be automatically + // updated to `preferred_renewal_method` in a few hours. + // + // Possible values: + // "RENEWAL_METHOD_UNSPECIFIED" - The renewal method is undefined. + // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each + // year. + // "MANUAL_RENEWAL" - Deprecated: For more information, see [Cloud + // Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) This option was never used. Use RENEWAL_DISABLED + // instead. + // "RENEWAL_DISABLED" - The domain won't be renewed and will expire at + // its expiration time. + PreferredRenewalMethod string `json:"preferredRenewalMethod,omitempty"` + + // RenewalMethod: Output only. The actual renewal method for this + // `Registration`. When `preferred_renewal_method` is set to + // `AUTOMATIC_RENEWAL` the actual `renewal_method` can be equal to + // `RENEWAL_DISABLED` in case of e.g. problems with the Billing Account + // or reported domain abuse. In such cases check the `issues` field on + // the `Registration`. After the problem is resolved the + // `renewal_method` will be automatically updated to + // `preferred_renewal_method` in a few hours. // // Possible values: // "RENEWAL_METHOD_UNSPECIFIED" - The renewal method is undefined. - // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each year - // . To disable automatic renewals, delete the resource by calling - // `DeleteRegistration` or export it by calling `ExportRegistration`. - // "MANUAL_RENEWAL" - The domain must be explicitly renewed each year - // before its `expire_time`. This option is only available when the - // `Registration` is in state `EXPORTED`. To manage the domain's current - // billing and renewal settings, go to [Google - // Domains](https://domains.google/). + // "AUTOMATIC_RENEWAL" - The domain is automatically renewed each + // year. + // "MANUAL_RENEWAL" - Deprecated: For more information, see [Cloud + // Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) This option was never used. Use RENEWAL_DISABLED + // instead. + // "RENEWAL_DISABLED" - The domain won't be renewed and will expire at + // its expiration time. RenewalMethod string `json:"renewalMethod,omitempty"` // TransferLockState: Controls whether the domain can be transferred to @@ -1221,20 +1271,22 @@ type ManagementSettings struct { // another registrar. TransferLockState string `json:"transferLockState,omitempty"` - // ForceSendFields is a list of field names (e.g. "RenewalMethod") 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 is a list of field names (e.g. + // "PreferredRenewalMethod") 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. "RenewalMethod") to include - // in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. However, any field with - // an empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "PreferredRenewalMethod") + // 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:"-"` } @@ -1728,15 +1780,20 @@ type RegisterParameters struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` // YearlyPrice: Price to register or renew the domain for one year. @@ -1774,16 +1831,21 @@ func (s *RegisterParameters) MarshalJSON() ([]byte, error) { // availability and obtain information like pricing, which is needed to // build a call to `RegisterDomain`. Another way to create a new // `Registration` is to transfer an existing domain from another -// registrar. First, go to the current registrar to unlock the domain -// for transfer and retrieve the domain's transfer authorization code. -// Then call `RetrieveTransferParameters` to confirm that the domain is -// unlocked and to get values needed to build a call to -// `TransferDomain`. Finally, you can create a new `Registration` by -// importing an existing domain managed with Google Domains -// (https://domains.google/). First, call `RetrieveImportableDomains` to -// list domains to which the calling user has sufficient access. Then -// call `ImportDomain` on any domain names you want to use with Cloud -// Domains. +// registrar (Deprecated: For more information, see Cloud Domains +// feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). +// First, go to the current registrar to unlock the domain for transfer +// and retrieve the domain's transfer authorization code. Then call +// `RetrieveTransferParameters` to confirm that the domain is unlocked +// and to get values needed to build a call to `TransferDomain`. +// Finally, you can create a new `Registration` by importing an existing +// domain managed with Google Domains (https://domains.google/) +// (Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations)). +// First, call `RetrieveImportableDomains` to list domains to which the +// calling user has sufficient access. Then call `ImportDomain` on any +// domain names you want to use with Cloud Domains. type Registration struct { // ContactSettings: Required. Settings for contact information linked to // the `Registration`. You cannot update these with the @@ -1825,6 +1887,9 @@ type Registration struct { // domain is suspended. To resend the verification email, call // ConfigureContactSettings and provide the current // `registrant_contact.email`. + // "PROBLEM_WITH_BILLING" - Billing account is not in good standing. + // The domain will not automatically renew at its expiration time unless + // you resolve problems with your billing account. Issues []string `json:"issues,omitempty"` // Labels: Set of labels associated with the `Registration`. @@ -1879,7 +1944,8 @@ type Registration struct { // "IMPORT_PENDING" - The domain is being imported from Google Domains // to Cloud Domains. // "ACTIVE" - The domain is registered and operational. The domain - // renews automatically as long as it remains in this state. + // renews automatically as long as it remains in this state and the + // RenewalMethod is set to AUTOMATIC_RENEWAL. // "SUSPENDED" - The domain is suspended and inoperative. For more // details, see the `issues` field. // "EXPORTED" - The domain is no longer managed with Cloud Domains. It @@ -1901,19 +1967,27 @@ type Registration struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` - // TransferFailureReason: Output only. The reason the domain transfer - // failed. Only set for domains in TRANSFER_FAILED state. + // TransferFailureReason: Output only. Deprecated: For more information, + // see Cloud Domains feature deprecation + // (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) + // The reason the domain transfer failed. Only set for domains in + // TRANSFER_FAILED state. // // Possible values: // "TRANSFER_FAILURE_REASON_UNSPECIFIED" - Transfer failure @@ -1974,8 +2048,10 @@ func (s *Registration) MarshalJSON() ([]byte, error) { type ResetAuthorizationCodeRequest struct { } -// RetrieveImportableDomainsResponse: Response for the -// `RetrieveImportableDomains` method. +// RetrieveImportableDomainsResponse: Deprecated: For more information, +// see Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Response for the `RetrieveImportableDomains` method. type RetrieveImportableDomainsResponse struct { // Domains: A list of domains that the calling user manages in Google // Domains. @@ -2048,8 +2124,10 @@ func (s *RetrieveRegisterParametersResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RetrieveTransferParametersResponse: Response for the -// `RetrieveTransferParameters` method. +// RetrieveTransferParametersResponse: Deprecated: For more information, +// see Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Response for the `RetrieveTransferParameters` method. type RetrieveTransferParametersResponse struct { // TransferParameters: Parameters to use when calling the // `TransferDomain` method. @@ -2263,7 +2341,10 @@ func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TransferDomainRequest: Request for the `TransferDomain` method. +// TransferDomainRequest: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Request for the `TransferDomain` method. type TransferDomainRequest struct { // AuthorizationCode: The domain's transfer authorization code. You can // obtain this from the domain's current registrar. @@ -2321,8 +2402,10 @@ func (s *TransferDomainRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TransferParameters: Parameters required to transfer a domain from -// another registrar. +// TransferParameters: Deprecated: For more information, see Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Parameters required to transfer a domain from another registrar. type TransferParameters struct { // CurrentRegistrar: The registrar that currently manages the domain. CurrentRegistrar string `json:"currentRegistrar,omitempty"` @@ -2348,15 +2431,20 @@ type TransferParameters struct { // publicly available. When setting this option, you must also provide a // `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field // of the request. - // "PRIVATE_CONTACT_DATA" - None of the data from `ContactSettings` is - // publicly available. Instead, proxy contact data is published for your - // domain. Email sent to the proxy email address is forwarded to the + // "PRIVATE_CONTACT_DATA" - Deprecated: For more information, see + // [Cloud Domains feature + // deprecation](https://cloud.google.com/domains/docs/deprecations/featur + // e-deprecations) None of the data from `ContactSettings` is publicly + // available. Instead, proxy contact data is published for your domain. + // Email sent to the proxy email address is forwarded to the // registrant's email address. Cloud Domains provides this privacy proxy // service at no additional cost. - // "REDACTED_CONTACT_DATA" - Some data from `ContactSettings` is - // publicly available. The actual information redacted depends on the - // domain. For details, see [the registration privacy - // article](https://support.google.com/domains/answer/3251242). + // "REDACTED_CONTACT_DATA" - The organization name (if provided) and + // limited non-identifying data from `ContactSettings` is available to + // the public (e.g. country and state). The remaining data is marked as + // `REDACTED FOR PRIVACY` in the WHOIS database. The actual information + // redacted depends on the domain. For details, see [the registration + // privacy article](https://support.google.com/domains/answer/3251242). SupportedPrivacy []string `json:"supportedPrivacy,omitempty"` // TransferLockState: Indicates whether the domain is protected by a @@ -3555,16 +3643,18 @@ type ProjectsLocationsRegistrationsDeleteCall struct { // Delete: Deletes a `Registration` resource. This method works on any // `Registration` resource using Subscription or Commitment billing // (/domains/pricing#billing-models), provided that the resource was -// created at least 1 day in the past. For `Registration` resources -// using Monthly billing (/domains/pricing#billing-models), this method -// works if: * `state` is `EXPORTED` with `expire_time` in the past * -// `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When -// an active registration is successfully deleted, you can continue to -// use the domain in Google Domains (https://domains.google/) until it -// expires. The calling user becomes the domain's sole owner in Google -// Domains, and permissions for the domain are subsequently managed -// there. The domain does not renew automatically unless the new owner -// sets up billing in Google Domains. +// created at least 1 day in the past. When an active registration is +// successfully deleted, you can continue to use the domain in Google +// Domains (https://domains.google/) until it expires. The calling user +// becomes the domain's sole owner in Google Domains, and permissions +// for the domain are subsequently managed there. The domain does not +// renew automatically unless the new owner sets up billing in Google +// Domains. After January 2024 you will only be able to delete +// `Registration` resources when `state` is one of: `EXPORTED`, +// `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See Cloud +// Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// for more details. // // - name: The name of the `Registration` to delete, in the format // `projects/*/locations/*/registrations/*`. @@ -3660,7 +3750,7 @@ func (c *ProjectsLocationsRegistrationsDeleteCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + // "description": "Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. After January 2024 you will only be able to delete `Registration` resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED` or `TRANSFER_FAILED`. See [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) for more details.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}", // "httpMethod": "DELETE", // "id": "domains.projects.locations.registrations.delete", @@ -3698,9 +3788,12 @@ type ProjectsLocationsRegistrationsExportCall struct { header_ http.Header } -// Export: Exports a `Registration` resource, such that it is no longer -// managed by Cloud Domains. When an active domain is successfully -// exported, you can continue to use the domain in Google Domains +// Export: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Exports a `Registration` resource, such that it is no longer managed +// by Cloud Domains. When an active domain is successfully exported, you +// can continue to use the domain in Google Domains // (https://domains.google/) until it expires. The calling user becomes // the domain's sole owner in Google Domains, and permissions for the // domain are subsequently managed there. The domain does not renew @@ -3806,7 +3899,8 @@ func (c *ProjectsLocationsRegistrationsExportCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.export", @@ -4169,11 +4263,14 @@ type ProjectsLocationsRegistrationsImportCall struct { header_ http.Header } -// Import: Imports a domain name from Google Domains -// (https://domains.google/) for use in Cloud Domains. To transfer a -// domain from another registrar, use the `TransferDomain` method -// instead. Since individual users can own domains in Google Domains, -// the calling user must have ownership permission on the domain. +// Import: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Imports a domain name from Google Domains (https://domains.google/) +// for use in Cloud Domains. To transfer a domain from another +// registrar, use the `TransferDomain` method instead. Since individual +// users can own domains in Google Domains, the calling user must have +// ownership permission on the domain. // // - parent: The parent resource of the Registration. Must be in the // format `projects/*/locations/*`. @@ -4275,7 +4372,8 @@ func (c *ProjectsLocationsRegistrationsImportCall) Do(opts ...googleapi.CallOpti } return ret, nil // { - // "description": "Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Imports a domain name from [Google Domains](https://domains.google/) for use in Cloud Domains. To transfer a domain from another registrar, use the `TransferDomain` method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:import", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.import", @@ -5146,12 +5244,14 @@ type ProjectsLocationsRegistrationsRetrieveImportableDomainsCall struct { header_ http.Header } -// RetrieveImportableDomains: Lists domain names from Google Domains -// (https://domains.google/) that can be imported to Cloud Domains using -// the `ImportDomain` method. Since individual users can own domains in -// Google Domains, the list of domains returned depends on the -// individual user making the call. Domains already managed by Cloud -// Domains are not returned. +// RetrieveImportableDomains: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Lists domain names from Google Domains (https://domains.google/) that +// can be imported to Cloud Domains using the `ImportDomain` method. +// Since individual users can own domains in Google Domains, the list of +// domains returned depends on the individual user making the call. +// Domains already managed by Cloud Domains are not returned. // // - location: The location. Must be in the format // `projects/*/locations/*`. @@ -5276,7 +5376,8 @@ func (c *ProjectsLocationsRegistrationsRetrieveImportableDomainsCall) Do(opts .. } return ret, nil // { - // "description": "Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Lists domain names from [Google Domains](https://domains.google/) that can be imported to Cloud Domains using the `ImportDomain` method. Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call. Domains already managed by Cloud Domains are not returned.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains", // "httpMethod": "GET", // "id": "domains.projects.locations.registrations.retrieveImportableDomains", @@ -5509,11 +5610,13 @@ type ProjectsLocationsRegistrationsRetrieveTransferParametersCall struct { header_ http.Header } -// RetrieveTransferParameters: Gets parameters needed to transfer a -// domain name from another registrar to Cloud Domains. For domains -// already managed by Google Domains (https://domains.google/), use -// `ImportDomain` instead. Use the returned values to call -// `TransferDomain`. +// RetrieveTransferParameters: Deprecated: For more information, see +// Cloud Domains feature deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Gets parameters needed to transfer a domain name from another +// registrar to Cloud Domains. For domains already managed by Google +// Domains (https://domains.google/), use `ImportDomain` instead. Use +// the returned values to call `TransferDomain`. // // - location: The location. Must be in the format // `projects/*/locations/*`. @@ -5631,7 +5734,8 @@ func (c *ProjectsLocationsRegistrationsRetrieveTransferParametersCall) Do(opts . } return ret, nil // { - // "description": "Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Use the returned values to call `TransferDomain`.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters", // "httpMethod": "GET", // "id": "domains.projects.locations.registrations.retrieveTransferParameters", @@ -6133,24 +6237,26 @@ type ProjectsLocationsRegistrationsTransferCall struct { header_ http.Header } -// Transfer: Transfers a domain name from another registrar to Cloud -// Domains. For domains already managed by Google Domains -// (https://domains.google/), use `ImportDomain` instead. Before calling -// this method, go to the domain's current registrar to unlock the -// domain for transfer and retrieve the domain's transfer authorization -// code. Then call `RetrieveTransferParameters` to confirm that the -// domain is unlocked and to get values needed to build a call to this -// method. A successful call creates a `Registration` resource in state -// `TRANSFER_PENDING`. It can take several days to complete the transfer -// process. The registrant can often speed up this process by approving -// the transfer through the current registrar, either by clicking a link -// in an email from the registrar or by visiting the registrar's -// website. A few minutes after transfer approval, the resource -// transitions to state `ACTIVE`, indicating that the transfer was -// successful. If the transfer is rejected or the request expires -// without being approved, the resource can end up in state -// `TRANSFER_FAILED`. If transfer fails, you can safely delete the -// resource and retry the transfer. +// Transfer: Deprecated: For more information, see Cloud Domains feature +// deprecation +// (https://cloud.google.com/domains/docs/deprecations/feature-deprecations) +// Transfers a domain name from another registrar to Cloud Domains. For +// domains already managed by Google Domains (https://domains.google/), +// use `ImportDomain` instead. Before calling this method, go to the +// domain's current registrar to unlock the domain for transfer and +// retrieve the domain's transfer authorization code. Then call +// `RetrieveTransferParameters` to confirm that the domain is unlocked +// and to get values needed to build a call to this method. A successful +// call creates a `Registration` resource in state `TRANSFER_PENDING`. +// It can take several days to complete the transfer process. The +// registrant can often speed up this process by approving the transfer +// through the current registrar, either by clicking a link in an email +// from the registrar or by visiting the registrar's website. A few +// minutes after transfer approval, the resource transitions to state +// `ACTIVE`, indicating that the transfer was successful. If the +// transfer is rejected or the request expires without being approved, +// the resource can end up in state `TRANSFER_FAILED`. If transfer +// fails, you can safely delete the resource and retry the transfer. // // - parent: The parent resource of the `Registration`. Must be in the // format `projects/*/locations/*`. @@ -6252,7 +6358,8 @@ func (c *ProjectsLocationsRegistrationsTransferCall) Do(opts ...googleapi.CallOp } return ret, nil // { - // "description": "Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", + // "deprecated": true, + // "description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations) Transfers a domain name from another registrar to Cloud Domains. For domains already managed by [Google Domains](https://domains.google/), use `ImportDomain` instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registrations:transfer", // "httpMethod": "POST", // "id": "domains.projects.locations.registrations.transfer", diff --git a/serviceusage/v1/serviceusage-api.json b/serviceusage/v1/serviceusage-api.json index 20902fdbb04..dbd509f028e 100644 --- a/serviceusage/v1/serviceusage-api.json +++ b/serviceusage/v1/serviceusage-api.json @@ -426,7 +426,7 @@ } } }, - "revision": "20230913", + "revision": "20231113", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1890,6 +1890,83 @@ }, "type": "object" }, + "GoogleApiServiceusageV2alphaConsumerPolicy": { + "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", + "id": "GoogleApiServiceusageV2alphaConsumerPolicy", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", + "type": "object" + }, + "createTime": { + "description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enableRules": { + "description": "Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases.", + "items": { + "$ref": "GoogleApiServiceusageV2alphaEnableRule" + }, + "type": "array" + }, + "etag": { + "description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the policy was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServiceusageV2alphaEnableRule": { + "description": "The consumer policy rule that defines enabled services, groups, and categories.", + "id": "GoogleApiServiceusageV2alphaEnableRule", + "properties": { + "categories": { + "description": "The names of the categories that are enabled. Example: `categories/googleServices`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "groups": { + "description": "The names of the service groups that are enabled. Example: `services/container.googleapis.com/groups/dependencies`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "services": { + "description": "The names of the services that are enabled. Example: `services/storage.googleapis.com`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata": { + "description": "Metadata for the `UpdateConsumerPolicy` method.", + "id": "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata", + "properties": {}, + "type": "object" + }, "Http": { "description": "Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.", "id": "Http", diff --git a/serviceusage/v1/serviceusage-gen.go b/serviceusage/v1/serviceusage-gen.go index 1b8bf3b1230..37348aba616 100644 --- a/serviceusage/v1/serviceusage-gen.go +++ b/serviceusage/v1/serviceusage-gen.go @@ -2599,6 +2599,106 @@ func (s *GoogleApiServiceusageV1beta1ServiceIdentity) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleApiServiceusageV2alphaConsumerPolicy: Consumer Policy is a set +// of rules that define what services or service groups can be used for +// a cloud resource hierarchy. +type GoogleApiServiceusageV2alphaConsumerPolicy struct { + // Annotations: Optional. Annotations is an unstructured key-value map + // stored with a policy that may be set by external tools to store and + // retrieve arbitrary metadata. They are not queryable and should be + // preserved when modifying objects. AIP-128 + // (https://google.aip.dev/128#annotations) + Annotations map[string]string `json:"annotations,omitempty"` + + // CreateTime: Output only. The time the policy was created. For + // singleton policies, this is the first touch of the policy. + CreateTime string `json:"createTime,omitempty"` + + // EnableRules: Enable rules define usable services, groups, and + // categories. There can currently be at most one `EnableRule`. This + // restriction will be lifted in later releases. + EnableRules []*GoogleApiServiceusageV2alphaEnableRule `json:"enableRules,omitempty"` + + // Etag: Output only. An opaque tag indicating the current version of + // the policy, used for concurrency control. + Etag string `json:"etag,omitempty"` + + // Name: Output only. The resource name of the policy. Only the + // `default` policy is supported: + // `projects/12345/consumerPolicies/default`, + // `folders/12345/consumerPolicies/default`, + // `organizations/12345/consumerPolicies/default`. + Name string `json:"name,omitempty"` + + // UpdateTime: Output only. The time the policy was last updated. + UpdateTime string `json:"updateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Annotations") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // 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. "Annotations") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleApiServiceusageV2alphaConsumerPolicy) MarshalJSON() ([]byte, error) { + type NoMethod GoogleApiServiceusageV2alphaConsumerPolicy + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleApiServiceusageV2alphaEnableRule: The consumer policy rule that +// defines enabled services, groups, and categories. +type GoogleApiServiceusageV2alphaEnableRule struct { + // Categories: The names of the categories that are enabled. Example: + // `categories/googleServices`. + Categories []string `json:"categories,omitempty"` + + // Groups: The names of the service groups that are enabled. Example: + // `services/container.googleapis.com/groups/dependencies`. + Groups []string `json:"groups,omitempty"` + + // Services: The names of the services that are enabled. Example: + // `services/storage.googleapis.com`. + Services []string `json:"services,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Categories") 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. "Categories") 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 *GoogleApiServiceusageV2alphaEnableRule) MarshalJSON() ([]byte, error) { + type NoMethod GoogleApiServiceusageV2alphaEnableRule + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: Metadata +// for the `UpdateConsumerPolicy` method. +type GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata struct { +} + // Http: Defines the HTTP configuration for an API service. It contains // a list of HttpRule, each specifying the mapping of an RPC method to // one or more HTTP REST API methods. diff --git a/serviceusage/v1beta1/serviceusage-api.json b/serviceusage/v1beta1/serviceusage-api.json index fba0a1821c2..1cf5770550d 100644 --- a/serviceusage/v1beta1/serviceusage-api.json +++ b/serviceusage/v1beta1/serviceusage-api.json @@ -964,7 +964,7 @@ } } }, - "revision": "20230913", + "revision": "20231113", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -2467,6 +2467,83 @@ }, "type": "object" }, + "GoogleApiServiceusageV2alphaConsumerPolicy": { + "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", + "id": "GoogleApiServiceusageV2alphaConsumerPolicy", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", + "type": "object" + }, + "createTime": { + "description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enableRules": { + "description": "Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases.", + "items": { + "$ref": "GoogleApiServiceusageV2alphaEnableRule" + }, + "type": "array" + }, + "etag": { + "description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the policy was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServiceusageV2alphaEnableRule": { + "description": "The consumer policy rule that defines enabled services, groups, and categories.", + "id": "GoogleApiServiceusageV2alphaEnableRule", + "properties": { + "categories": { + "description": "The names of the categories that are enabled. Example: `categories/googleServices`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "groups": { + "description": "The names of the service groups that are enabled. Example: `services/container.googleapis.com/groups/dependencies`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "services": { + "description": "The names of the services that are enabled. Example: `services/storage.googleapis.com`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata": { + "description": "Metadata for the `UpdateConsumerPolicy` method.", + "id": "GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata", + "properties": {}, + "type": "object" + }, "Http": { "description": "Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.", "id": "Http", diff --git a/serviceusage/v1beta1/serviceusage-gen.go b/serviceusage/v1beta1/serviceusage-gen.go index 62c0d8855be..b719a98338c 100644 --- a/serviceusage/v1beta1/serviceusage-gen.go +++ b/serviceusage/v1beta1/serviceusage-gen.go @@ -2687,6 +2687,106 @@ func (s *GoogleApiServiceusageV1beta1ServiceIdentity) MarshalJSON() ([]byte, err return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleApiServiceusageV2alphaConsumerPolicy: Consumer Policy is a set +// of rules that define what services or service groups can be used for +// a cloud resource hierarchy. +type GoogleApiServiceusageV2alphaConsumerPolicy struct { + // Annotations: Optional. Annotations is an unstructured key-value map + // stored with a policy that may be set by external tools to store and + // retrieve arbitrary metadata. They are not queryable and should be + // preserved when modifying objects. AIP-128 + // (https://google.aip.dev/128#annotations) + Annotations map[string]string `json:"annotations,omitempty"` + + // CreateTime: Output only. The time the policy was created. For + // singleton policies, this is the first touch of the policy. + CreateTime string `json:"createTime,omitempty"` + + // EnableRules: Enable rules define usable services, groups, and + // categories. There can currently be at most one `EnableRule`. This + // restriction will be lifted in later releases. + EnableRules []*GoogleApiServiceusageV2alphaEnableRule `json:"enableRules,omitempty"` + + // Etag: Output only. An opaque tag indicating the current version of + // the policy, used for concurrency control. + Etag string `json:"etag,omitempty"` + + // Name: Output only. The resource name of the policy. Only the + // `default` policy is supported: + // `projects/12345/consumerPolicies/default`, + // `folders/12345/consumerPolicies/default`, + // `organizations/12345/consumerPolicies/default`. + Name string `json:"name,omitempty"` + + // UpdateTime: Output only. The time the policy was last updated. + UpdateTime string `json:"updateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Annotations") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // 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. "Annotations") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleApiServiceusageV2alphaConsumerPolicy) MarshalJSON() ([]byte, error) { + type NoMethod GoogleApiServiceusageV2alphaConsumerPolicy + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleApiServiceusageV2alphaEnableRule: The consumer policy rule that +// defines enabled services, groups, and categories. +type GoogleApiServiceusageV2alphaEnableRule struct { + // Categories: The names of the categories that are enabled. Example: + // `categories/googleServices`. + Categories []string `json:"categories,omitempty"` + + // Groups: The names of the service groups that are enabled. Example: + // `services/container.googleapis.com/groups/dependencies`. + Groups []string `json:"groups,omitempty"` + + // Services: The names of the services that are enabled. Example: + // `services/storage.googleapis.com`. + Services []string `json:"services,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Categories") 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. "Categories") 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 *GoogleApiServiceusageV2alphaEnableRule) MarshalJSON() ([]byte, error) { + type NoMethod GoogleApiServiceusageV2alphaEnableRule + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: Metadata +// for the `UpdateConsumerPolicy` method. +type GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata struct { +} + // Http: Defines the HTTP configuration for an API service. It contains // a list of HttpRule, each specifying the mapping of an RPC method to // one or more HTTP REST API methods. diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json index d6fc09bf183..c06bb15cbfb 100644 --- a/speech/v1/speech-api.json +++ b/speech/v1/speech-api.json @@ -524,7 +524,7 @@ } } }, - "revision": "20230901", + "revision": "20231110", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -674,6 +674,25 @@ "properties": {}, "type": "object" }, + "Entry": { + "description": "A single replacement configuration.", + "id": "Entry", + "properties": { + "caseSensitive": { + "description": "Whether the search is case sensitive.", + "type": "boolean" + }, + "replace": { + "description": "What to replace with. Max length is 100 characters.", + "type": "string" + }, + "search": { + "description": "What to replace. Max length is 100 characters.", + "type": "string" + } + }, + "type": "object" + }, "ListCustomClassesResponse": { "description": "Message returned to the client by the `ListCustomClasses` method.", "id": "ListCustomClassesResponse", @@ -1024,6 +1043,7 @@ "AMR_WB", "OGG_OPUS", "SPEEX_WITH_HEADER_BYTE", + "MP3", "WEBM_OPUS" ], "enumDescriptions": [ @@ -1035,7 +1055,8 @@ "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Cloud Speech API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", - "Opus encoded audio frames in WebM container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000." + "MP3 audio. MP3 encoding is a Beta feature and only available in v1p1beta1. Support all standard MP3 bitrates (which range from 32-320 kbps). When using this encoding, `sample_rate_hertz` has to match the sample rate of the file being used.", + "Opus encoded audio frames in WebM container ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000." ], "type": "string" }, @@ -1072,6 +1093,10 @@ }, "type": "array" }, + "transcriptNormalization": { + "$ref": "TranscriptNormalization", + "description": "Optional. Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability \u003e 0.8) and final transcripts." + }, "useEnhanced": { "description": "Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model.", "type": "boolean" @@ -1398,6 +1423,20 @@ }, "type": "object" }, + "TranscriptNormalization": { + "description": "Transcription normalization configuration. Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability \u003e 0.8) and final transcripts.", + "id": "TranscriptNormalization", + "properties": { + "entries": { + "description": "A list of replacement entries. We will perform replacement with one entry at a time. For example, the second entry in [\"cat\" =\u003e \"dog\", \"mountain cat\" =\u003e \"mountain dog\"] will never be applied because we will always process the first entry before it. At most 100 entries.", + "items": { + "$ref": "Entry" + }, + "type": "array" + } + }, + "type": "object" + }, "TranscriptOutputConfig": { "description": "Specifies an optional destination for the recognition results.", "id": "TranscriptOutputConfig", diff --git a/speech/v1/speech-gen.go b/speech/v1/speech-gen.go index b931a281af8..95c45761039 100644 --- a/speech/v1/speech-gen.go +++ b/speech/v1/speech-gen.go @@ -461,6 +461,40 @@ type Empty struct { googleapi.ServerResponse `json:"-"` } +// Entry: A single replacement configuration. +type Entry struct { + // CaseSensitive: Whether the search is case sensitive. + CaseSensitive bool `json:"caseSensitive,omitempty"` + + // Replace: What to replace with. Max length is 100 characters. + Replace string `json:"replace,omitempty"` + + // Search: What to replace. Max length is 100 characters. + Search string `json:"search,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CaseSensitive") 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. "CaseSensitive") 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 *Entry) MarshalJSON() ([]byte, error) { + type NoMethod Entry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ListCustomClassesResponse: Message returned to the client by the // `ListCustomClasses` method. type ListCustomClassesResponse struct { @@ -1132,9 +1166,15 @@ type RecognitionConfig struct { // words, each RTP header is replaced with a single byte containing the // block length. Only Speex wideband is supported. `sample_rate_hertz` // must be 16000. + // "MP3" - MP3 audio. MP3 encoding is a Beta feature and only + // available in v1p1beta1. Support all standard MP3 bitrates (which + // range from 32-320 kbps). When using this encoding, + // `sample_rate_hertz` has to match the sample rate of the file being + // used. // "WEBM_OPUS" - Opus encoded audio frames in WebM container - // ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must - // be one of 8000, 12000, 16000, 24000, or 48000. + // ([WebM](https://www.webmproject.org/docs/container/)). + // `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or + // 48000. Encoding string `json:"encoding,omitempty"` // LanguageCode: Required. The language of the supplied audio as a @@ -1197,6 +1237,12 @@ type RecognitionConfig struct { // adaptation (https://cloud.google.com/speech-to-text/docs/adaptation). SpeechContexts []*SpeechContext `json:"speechContexts,omitempty"` + // TranscriptNormalization: Optional. Use transcription normalization to + // automatically replace parts of the transcript with phrases of your + // choosing. For StreamingRecognize, this normalization only applies to + // stable partial transcripts (stability > 0.8) and final transcripts. + TranscriptNormalization *TranscriptNormalization `json:"transcriptNormalization,omitempty"` + // UseEnhanced: Set to true to use an enhanced model for speech // recognition. If `use_enhanced` is set to true and the `model` field // is not set, then an appropriate enhanced model is chosen if an @@ -1760,6 +1806,42 @@ func (s *Status) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// TranscriptNormalization: Transcription normalization configuration. +// Use transcription normalization to automatically replace parts of the +// transcript with phrases of your choosing. For StreamingRecognize, +// this normalization only applies to stable partial transcripts +// (stability > 0.8) and final transcripts. +type TranscriptNormalization struct { + // Entries: A list of replacement entries. We will perform replacement + // with one entry at a time. For example, the second entry in ["cat" => + // "dog", "mountain cat" => "mountain dog"] will never be applied + // because we will always process the first entry before it. At most 100 + // entries. + Entries []*Entry `json:"entries,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Entries") 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. "Entries") 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 *TranscriptNormalization) MarshalJSON() ([]byte, error) { + type NoMethod TranscriptNormalization + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // TranscriptOutputConfig: Specifies an optional destination for the // recognition results. type TranscriptOutputConfig struct { diff --git a/speech/v1p1beta1/speech-api.json b/speech/v1p1beta1/speech-api.json index d2a224834e6..c91d0f9dfda 100644 --- a/speech/v1p1beta1/speech-api.json +++ b/speech/v1p1beta1/speech-api.json @@ -524,7 +524,7 @@ } } }, - "revision": "20230901", + "revision": "20231110", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -1072,7 +1072,7 @@ "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Cloud Speech API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", "MP3 audio. MP3 encoding is a Beta feature and only available in v1p1beta1. Support all standard MP3 bitrates (which range from 32-320 kbps). When using this encoding, `sample_rate_hertz` has to match the sample rate of the file being used.", - "Opus encoded audio frames in WebM container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000." + "Opus encoded audio frames in WebM container ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000." ], "type": "string" }, @@ -1111,7 +1111,7 @@ }, "transcriptNormalization": { "$ref": "TranscriptNormalization", - "description": "Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability \u003e 0.8) and final transcripts." + "description": "Optional. Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability \u003e 0.8) and final transcripts." }, "useEnhanced": { "description": "Set to true to use an enhanced model for speech recognition. If `use_enhanced` is set to true and the `model` field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio. If `use_enhanced` is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model.", diff --git a/speech/v1p1beta1/speech-gen.go b/speech/v1p1beta1/speech-gen.go index 8d116ee74e8..3dceee22dae 100644 --- a/speech/v1p1beta1/speech-gen.go +++ b/speech/v1p1beta1/speech-gen.go @@ -1188,8 +1188,9 @@ type RecognitionConfig struct { // `sample_rate_hertz` has to match the sample rate of the file being // used. // "WEBM_OPUS" - Opus encoded audio frames in WebM container - // ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must - // be one of 8000, 12000, 16000, 24000, or 48000. + // ([WebM](https://www.webmproject.org/docs/container/)). + // `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or + // 48000. Encoding string `json:"encoding,omitempty"` // LanguageCode: Required. The language of the supplied audio as a @@ -1252,7 +1253,7 @@ type RecognitionConfig struct { // adaptation (https://cloud.google.com/speech-to-text/docs/adaptation). SpeechContexts []*SpeechContext `json:"speechContexts,omitempty"` - // TranscriptNormalization: Use transcription normalization to + // TranscriptNormalization: Optional. Use transcription normalization to // automatically replace parts of the transcript with phrases of your // choosing. For StreamingRecognize, this normalization only applies to // stable partial transcripts (stability > 0.8) and final transcripts. diff --git a/sqladmin/v1/sqladmin-api.json b/sqladmin/v1/sqladmin-api.json index d67fbe5fdcd..ed879bdfcb2 100644 --- a/sqladmin/v1/sqladmin-api.json +++ b/sqladmin/v1/sqladmin-api.json @@ -2200,7 +2200,7 @@ } } }, - "revision": "20231029", + "revision": "20231108", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2248,12 +2248,16 @@ "enum": [ "SQL_API_WARNING_CODE_UNSPECIFIED", "REGION_UNREACHABLE", - "MAX_RESULTS_EXCEEDS_LIMIT" + "MAX_RESULTS_EXCEEDS_LIMIT", + "COMPROMISED_CREDENTIALS", + "INTERNAL_STATE_FAILURE" ], "enumDescriptions": [ "An unknown or unset warning type from Cloud SQL API.", "Warning when one or more regions are not reachable. The returned result set may be incomplete.", - "Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete." + "Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete.", + "Warning when user tries to create/update a user with credentials that have previously been compromised by a public data breach.", + "Warning when the operation succeeds but some non-critical workflow state failed." ], "type": "string" }, @@ -3164,6 +3168,19 @@ "$ref": "Settings", "description": "The user settings." }, + "sqlNetworkArchitecture": { + "enum": [ + "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED", + "NEW_NETWORK_ARCHITECTURE", + "OLD_NETWORK_ARCHITECTURE" + ], + "enumDescriptions": [ + "", + "Instance is a Tenancy Unit (TU) instance.", + "Instance is an Umbrella instance." + ], + "type": "string" + }, "state": { "description": "The current serving state of the Cloud SQL instance.", "enum": [ @@ -4265,12 +4282,14 @@ "enum": [ "SQL_UPDATE_TRACK_UNSPECIFIED", "canary", - "stable" + "stable", + "week5" ], "enumDescriptions": [ "This is an unknown maintenance timing preference.", "For instance update that requires a restart, this update track indicates your instance prefer to restart for new version early in maintenance window.", - "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable)." + "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable).", + "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable) to be at least 5 weeks after the notification." ], "type": "string" } @@ -4391,6 +4410,10 @@ "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.", "id": "Operation", "properties": { + "apiWarning": { + "$ref": "ApiWarning", + "description": "An Admin API warning message." + }, "backupContext": { "$ref": "BackupContext", "description": "The context for backup operation, if applicable." @@ -4730,6 +4753,10 @@ ], "type": "string" }, + "disallowCompromisedCredentials": { + "description": "Disallow credentials that have been previously compromised by a public data breach.", + "type": "boolean" + }, "disallowUsernameSubstring": { "description": "Disallow username as a part of the password.", "type": "boolean" diff --git a/sqladmin/v1/sqladmin-gen.go b/sqladmin/v1/sqladmin-gen.go index 93a59d24268..81ed62a273d 100644 --- a/sqladmin/v1/sqladmin-gen.go +++ b/sqladmin/v1/sqladmin-gen.go @@ -371,6 +371,11 @@ type ApiWarning struct { // "MAX_RESULTS_EXCEEDS_LIMIT" - Warning when user provided maxResults // parameter exceeds the limit. The returned result set may be // incomplete. + // "COMPROMISED_CREDENTIALS" - Warning when user tries to + // create/update a user with credentials that have previously been + // compromised by a public data breach. + // "INTERNAL_STATE_FAILURE" - Warning when the operation succeeds but + // some non-critical workflow state failed. Code string `json:"code,omitempty"` // Message: The warning message. @@ -1329,6 +1334,13 @@ type DatabaseInstance struct { // Settings: The user settings. Settings *Settings `json:"settings,omitempty"` + // Possible values: + // "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED" + // "NEW_NETWORK_ARCHITECTURE" - Instance is a Tenancy Unit (TU) + // instance. + // "OLD_NETWORK_ARCHITECTURE" - Instance is an Umbrella instance. + SqlNetworkArchitecture string `json:"sqlNetworkArchitecture,omitempty"` + // State: The current serving state of the Cloud SQL instance. // // Possible values: @@ -3187,6 +3199,10 @@ type MaintenanceWindow struct { // "stable" - For instance update that requires a restart, this update // track indicates your instance prefer to let Cloud SQL choose the // timing of restart (within its Maintenance window, if applicable). + // "week5" - For instance update that requires a restart, this update + // track indicates your instance prefer to let Cloud SQL choose the + // timing of restart (within its Maintenance window, if applicable) to + // be at least 5 weeks after the notification. UpdateTrack string `json:"updateTrack,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to @@ -3373,6 +3389,9 @@ func (s *OnPremisesConfiguration) MarshalJSON() ([]byte, error) { // return an Operation resource, only the fields relevant to the // operation are populated in the resource. type Operation struct { + // ApiWarning: An Admin API warning message. + ApiWarning *ApiWarning `json:"apiWarning,omitempty"` + // BackupContext: The context for backup operation, if applicable. BackupContext *BackupContext `json:"backupContext,omitempty"` @@ -3496,7 +3515,7 @@ type Operation struct { // server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "BackupContext") to + // ForceSendFields is a list of field names (e.g. "ApiWarning") 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 @@ -3504,10 +3523,10 @@ type Operation struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BackupContext") 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. "ApiWarning") 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:"-"` @@ -3719,6 +3738,10 @@ type PasswordValidationPolicy struct { // numeric, and non-alphanumeric characters. Complexity string `json:"complexity,omitempty"` + // DisallowCompromisedCredentials: Disallow credentials that have been + // previously compromised by a public data breach. + DisallowCompromisedCredentials bool `json:"disallowCompromisedCredentials,omitempty"` + // DisallowUsernameSubstring: Disallow username as a part of the // password. DisallowUsernameSubstring bool `json:"disallowUsernameSubstring,omitempty"` diff --git a/sqladmin/v1beta4/sqladmin-api.json b/sqladmin/v1beta4/sqladmin-api.json index 7d5e8ce257f..e0845edb09f 100644 --- a/sqladmin/v1beta4/sqladmin-api.json +++ b/sqladmin/v1beta4/sqladmin-api.json @@ -2200,7 +2200,7 @@ } } }, - "revision": "20231029", + "revision": "20231108", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2248,12 +2248,16 @@ "enum": [ "SQL_API_WARNING_CODE_UNSPECIFIED", "REGION_UNREACHABLE", - "MAX_RESULTS_EXCEEDS_LIMIT" + "MAX_RESULTS_EXCEEDS_LIMIT", + "COMPROMISED_CREDENTIALS", + "INTERNAL_STATE_FAILURE" ], "enumDescriptions": [ "An unknown or unset warning type from Cloud SQL API.", "Warning when one or more regions are not reachable. The returned result set may be incomplete.", - "Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete." + "Warning when user provided maxResults parameter exceeds the limit. The returned result set may be incomplete.", + "Warning when user tries to create/update a user with credentials that have previously been compromised by a public data breach.", + "Warning when the operation succeeds but some non-critical workflow state failed." ], "type": "string" }, @@ -3164,6 +3168,20 @@ "$ref": "Settings", "description": "The user settings." }, + "sqlNetworkArchitecture": { + "description": "The SQL network architecture for the instance.", + "enum": [ + "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED", + "NEW_NETWORK_ARCHITECTURE", + "OLD_NETWORK_ARCHITECTURE" + ], + "enumDescriptions": [ + "", + "Instance is a Tenancy Unit (TU) instance.", + "Instance is an Umbrella instance." + ], + "type": "string" + }, "state": { "description": "The current serving state of the Cloud SQL instance.", "enum": [ @@ -4265,12 +4283,14 @@ "enum": [ "SQL_UPDATE_TRACK_UNSPECIFIED", "canary", - "stable" + "stable", + "week5" ], "enumDescriptions": [ "This is an unknown maintenance timing preference.", "For instance update that requires a restart, this update track indicates your instance prefer to restart for new version early in maintenance window.", - "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable)." + "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable).", + "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable) to be at least 5 weeks after the notification." ], "type": "string" } @@ -4391,6 +4411,10 @@ "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.", "id": "Operation", "properties": { + "apiWarning": { + "$ref": "ApiWarning", + "description": "An Admin API warning message." + }, "backupContext": { "$ref": "BackupContext", "description": "The context for backup operation, if applicable." @@ -4730,6 +4754,10 @@ ], "type": "string" }, + "disallowCompromisedCredentials": { + "description": "Disallow credentials that have been previously compromised by a public data breach.", + "type": "boolean" + }, "disallowUsernameSubstring": { "description": "Disallow username as a part of the password.", "type": "boolean" diff --git a/sqladmin/v1beta4/sqladmin-gen.go b/sqladmin/v1beta4/sqladmin-gen.go index e46a0b5c2a9..c046b031a49 100644 --- a/sqladmin/v1beta4/sqladmin-gen.go +++ b/sqladmin/v1beta4/sqladmin-gen.go @@ -371,6 +371,11 @@ type ApiWarning struct { // "MAX_RESULTS_EXCEEDS_LIMIT" - Warning when user provided maxResults // parameter exceeds the limit. The returned result set may be // incomplete. + // "COMPROMISED_CREDENTIALS" - Warning when user tries to + // create/update a user with credentials that have previously been + // compromised by a public data breach. + // "INTERNAL_STATE_FAILURE" - Warning when the operation succeeds but + // some non-critical workflow state failed. Code string `json:"code,omitempty"` // Message: The warning message. @@ -1328,6 +1333,16 @@ type DatabaseInstance struct { // Settings: The user settings. Settings *Settings `json:"settings,omitempty"` + // SqlNetworkArchitecture: The SQL network architecture for the + // instance. + // + // Possible values: + // "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED" + // "NEW_NETWORK_ARCHITECTURE" - Instance is a Tenancy Unit (TU) + // instance. + // "OLD_NETWORK_ARCHITECTURE" - Instance is an Umbrella instance. + SqlNetworkArchitecture string `json:"sqlNetworkArchitecture,omitempty"` + // State: The current serving state of the Cloud SQL instance. // // Possible values: @@ -3189,6 +3204,10 @@ type MaintenanceWindow struct { // "stable" - For instance update that requires a restart, this update // track indicates your instance prefer to let Cloud SQL choose the // timing of restart (within its Maintenance window, if applicable). + // "week5" - For instance update that requires a restart, this update + // track indicates your instance prefer to let Cloud SQL choose the + // timing of restart (within its Maintenance window, if applicable) to + // be at least 5 weeks after the notification. UpdateTrack string `json:"updateTrack,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to @@ -3375,6 +3394,9 @@ func (s *OnPremisesConfiguration) MarshalJSON() ([]byte, error) { // return an Operation resource, only the fields relevant to the // operation are populated in the resource. type Operation struct { + // ApiWarning: An Admin API warning message. + ApiWarning *ApiWarning `json:"apiWarning,omitempty"` + // BackupContext: The context for backup operation, if applicable. BackupContext *BackupContext `json:"backupContext,omitempty"` @@ -3498,7 +3520,7 @@ type Operation struct { // server. googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "BackupContext") to + // ForceSendFields is a list of field names (e.g. "ApiWarning") 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 @@ -3506,10 +3528,10 @@ type Operation struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BackupContext") 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. "ApiWarning") 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:"-"` @@ -3721,6 +3743,10 @@ type PasswordValidationPolicy struct { // numeric, and non-alphanumeric characters. Complexity string `json:"complexity,omitempty"` + // DisallowCompromisedCredentials: Disallow credentials that have been + // previously compromised by a public data breach. + DisallowCompromisedCredentials bool `json:"disallowCompromisedCredentials,omitempty"` + // DisallowUsernameSubstring: Disallow username as a part of the // password. DisallowUsernameSubstring bool `json:"disallowUsernameSubstring,omitempty"`