Skip to content

Commit 8abc4a1

Browse files
feat(domains): update the api
#### domains:v1 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.retrieveGoogleDomainsDnsRecords (Total Keys: 16) - schemas.DnsSettings.properties.googleDomainsRedirectsDataAvailable (Total Keys: 2) - schemas.GeoPolicy (Total Keys: 13) - schemas.HealthCheckTargets (Total Keys: 4) - schemas.LoadBalancerTarget (Total Keys: 8) - schemas.PrimaryBackupPolicy (Total Keys: 6) - schemas.RRSetRoutingPolicy (Total Keys: 9) - schemas.ResourceRecordSet (Total Keys: 11) - schemas.RetrieveGoogleDomainsDnsRecordsResponse (Total Keys: 5) - schemas.WrrPolicy (Total Keys: 13) #### domains:v1alpha2 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.retrieveGoogleDomainsDnsRecords (Total Keys: 16) - schemas.DnsSettings.properties.googleDomainsRedirectsDataAvailable (Total Keys: 2) - schemas.GeoPolicy (Total Keys: 13) - schemas.HealthCheckTargets (Total Keys: 4) - schemas.LoadBalancerTarget (Total Keys: 8) - schemas.PrimaryBackupPolicy (Total Keys: 6) - schemas.RRSetRoutingPolicy (Total Keys: 9) - schemas.ResourceRecordSet (Total Keys: 11) - schemas.RetrieveGoogleDomainsDnsRecordsResponse (Total Keys: 5) - schemas.WrrPolicy (Total Keys: 13) #### domains:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.registrations.methods.retrieveGoogleDomainsDnsRecords (Total Keys: 16) - schemas.DnsSettings.properties.googleDomainsRedirectsDataAvailable (Total Keys: 2) - schemas.GeoPolicy (Total Keys: 13) - schemas.HealthCheckTargets (Total Keys: 4) - schemas.LoadBalancerTarget (Total Keys: 8) - schemas.PrimaryBackupPolicy (Total Keys: 6) - schemas.RRSetRoutingPolicy (Total Keys: 9) - schemas.ResourceRecordSet (Total Keys: 11) - schemas.RetrieveGoogleDomainsDnsRecordsResponse (Total Keys: 5) - schemas.WrrPolicy (Total Keys: 13)
1 parent b1cb74b commit 8abc4a1

File tree

6 files changed

+1536
-3
lines changed

6 files changed

+1536
-3
lines changed

docs/dyn/domains_v1.projects.locations.registrations.html

Lines changed: 211 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/domains_v1alpha2.projects.locations.registrations.html

Lines changed: 211 additions & 0 deletions
Large diffs are not rendered by default.

docs/dyn/domains_v1beta1.projects.locations.registrations.html

Lines changed: 211 additions & 0 deletions
Large diffs are not rendered by default.

googleapiclient/discovery_cache/documents/domains.v1.json

Lines changed: 301 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -684,6 +684,42 @@
684684
"https://www.googleapis.com/auth/cloud-platform"
685685
]
686686
},
687+
"retrieveGoogleDomainsDnsRecords": {
688+
"description": "Lists the DNS records from the Google Domains DNS zone for domains that use the deprecated `google_domains_dns` in the `Registration`'s `dns_settings`.",
689+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsDnsRecords",
690+
"httpMethod": "GET",
691+
"id": "domains.projects.locations.registrations.retrieveGoogleDomainsDnsRecords",
692+
"parameterOrder": [
693+
"registration"
694+
],
695+
"parameters": {
696+
"pageSize": {
697+
"description": "Optional. Maximum number of results to return.",
698+
"format": "int32",
699+
"location": "query",
700+
"type": "integer"
701+
},
702+
"pageToken": {
703+
"description": "Optional. When set to the `next_page_token` from a prior response, provides the next page of results.",
704+
"location": "query",
705+
"type": "string"
706+
},
707+
"registration": {
708+
"description": "Required. The name of the `Registration` whose Google Domains DNS records details you are retrieving, in the format `projects/*/locations/*/registrations/*`.",
709+
"location": "path",
710+
"pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$",
711+
"required": true,
712+
"type": "string"
713+
}
714+
},
715+
"path": "v1/{+registration}:retrieveGoogleDomainsDnsRecords",
716+
"response": {
717+
"$ref": "RetrieveGoogleDomainsDnsRecordsResponse"
718+
},
719+
"scopes": [
720+
"https://www.googleapis.com/auth/cloud-platform"
721+
]
722+
},
687723
"retrieveGoogleDomainsForwardingConfig": {
688724
"description": "Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.",
689725
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig",
@@ -929,7 +965,7 @@
929965
}
930966
}
931967
},
932-
"revision": "20240603",
968+
"revision": "20240610",
933969
"rootUrl": "https://domains.googleapis.com/",
934970
"schemas": {
935971
"AuditConfig": {
@@ -1188,6 +1224,11 @@ false
11881224
"$ref": "GoogleDomainsDns",
11891225
"deprecated": true,
11901226
"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/)."
1227+
},
1228+
"googleDomainsRedirectsDataAvailable": {
1229+
"description": "Output only. Indicates if this `Registration` has configured one of the following deprecated Google Domains DNS features: * Domain forwarding (HTTP `301` and `302` response status codes), * Email forwarding. See https://cloud.google.com/domains/docs/deprecations/feature-deprecations for more details. If any of these features is enabled call the `RetrieveGoogleDomainsForwardingConfig` method to get details about the feature's configuration. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.",
1230+
"readOnly": true,
1231+
"type": "boolean"
11911232
}
11921233
},
11931234
"type": "object"
@@ -1391,6 +1432,52 @@ false
13911432
},
13921433
"type": "object"
13931434
},
1435+
"GeoPolicy": {
1436+
"description": "Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.",
1437+
"id": "GeoPolicy",
1438+
"properties": {
1439+
"enableFencing": {
1440+
"description": "Without fencing, if health check fails for all configured items in the current geo bucket, we failover to the next nearest geo bucket. With fencing, if health checking is enabled, as long as some targets in the current geo bucket are healthy, we return only the healthy targets. However, if all targets are unhealthy, we don't failover to the next nearest bucket; instead, we return all the items in the current bucket even when all targets are unhealthy.",
1441+
"type": "boolean"
1442+
},
1443+
"item": {
1444+
"description": "The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.",
1445+
"items": {
1446+
"$ref": "GeoPolicyItem"
1447+
},
1448+
"type": "array"
1449+
}
1450+
},
1451+
"type": "object"
1452+
},
1453+
"GeoPolicyItem": {
1454+
"description": "ResourceRecordSet data for one geo location.",
1455+
"id": "GeoPolicyItem",
1456+
"properties": {
1457+
"healthCheckedTargets": {
1458+
"$ref": "HealthCheckTargets",
1459+
"description": "For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item."
1460+
},
1461+
"location": {
1462+
"description": "The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g. \"us-east1\", \"southamerica-east1\", \"asia-east1\", etc.",
1463+
"type": "string"
1464+
},
1465+
"rrdata": {
1466+
"items": {
1467+
"type": "string"
1468+
},
1469+
"type": "array"
1470+
},
1471+
"signatureRrdata": {
1472+
"description": "DNSSEC generated signatures for all the `rrdata` within this item. If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.",
1473+
"items": {
1474+
"type": "string"
1475+
},
1476+
"type": "array"
1477+
}
1478+
},
1479+
"type": "object"
1480+
},
13941481
"GlueRecord": {
13951482
"description": "Defines a host on your domain that is a DNS name server for your domain and/or other domains. Glue records are a way of making the IP address of a name server known, even when it serves DNS queries for its parent domain. For example, when `ns.example.com` is a name server for `example.com`, the host `ns.example.com` must have a glue record to break the circular DNS reference.",
13961483
"id": "GlueRecord",
@@ -1454,6 +1541,20 @@ false
14541541
},
14551542
"type": "object"
14561543
},
1544+
"HealthCheckTargets": {
1545+
"description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.",
1546+
"id": "HealthCheckTargets",
1547+
"properties": {
1548+
"internalLoadBalancer": {
1549+
"description": "Configuration for internal load balancers to be health checked.",
1550+
"items": {
1551+
"$ref": "LoadBalancerTarget"
1552+
},
1553+
"type": "array"
1554+
}
1555+
},
1556+
"type": "object"
1557+
},
14571558
"ImportDomainRequest": {
14581559
"deprecated": true,
14591560
"description": "Deprecated: For more information, see [Cloud Domains feature deprecation](https://cloud.google.com/domains/docs/deprecations/feature-deprecations). Request for the `ImportDomain` method.",
@@ -1538,6 +1639,63 @@ false
15381639
},
15391640
"type": "object"
15401641
},
1642+
"LoadBalancerTarget": {
1643+
"description": "The configuration for an individual load balancer to health check.",
1644+
"id": "LoadBalancerTarget",
1645+
"properties": {
1646+
"ipAddress": {
1647+
"description": "The frontend IP address of the load balancer to health check.",
1648+
"type": "string"
1649+
},
1650+
"ipProtocol": {
1651+
"description": "The protocol of the load balancer to health check.",
1652+
"enum": [
1653+
"UNDEFINED",
1654+
"TCP",
1655+
"UDP"
1656+
],
1657+
"enumDescriptions": [
1658+
"",
1659+
"Indicates the load balancer is accessible via TCP.",
1660+
"Indicates the load balancer is accessible via UDP."
1661+
],
1662+
"type": "string"
1663+
},
1664+
"loadBalancerType": {
1665+
"description": "The type of load balancer specified by this target. This value must match the configuration of the load balancer located at the LoadBalancerTarget's IP address, port, and region. Use the following: - *regionalL4ilb*: for a regional internal passthrough Network Load Balancer. - *regionalL7ilb*: for a regional internal Application Load Balancer. - *globalL7ilb*: for a global internal Application Load Balancer. ",
1666+
"enum": [
1667+
"NONE",
1668+
"GLOBAL_L7ILB",
1669+
"REGIONAL_L4ILB",
1670+
"REGIONAL_L7ILB"
1671+
],
1672+
"enumDescriptions": [
1673+
"",
1674+
"Indicates the load balancer is a Cross-Region Application Load Balancer.",
1675+
"Indicates the load balancer is a Regional Network Passthrough Load Balancer.",
1676+
"Indicates the load balancer is a Regional Application Load Balancer."
1677+
],
1678+
"type": "string"
1679+
},
1680+
"networkUrl": {
1681+
"description": "The fully qualified URL of the network that the load balancer is attached to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`.",
1682+
"type": "string"
1683+
},
1684+
"port": {
1685+
"description": "The configured port of the load balancer.",
1686+
"type": "string"
1687+
},
1688+
"project": {
1689+
"description": "The project ID in which the load balancer is located.",
1690+
"type": "string"
1691+
},
1692+
"region": {
1693+
"description": "The region in which the load balancer is located.",
1694+
"type": "string"
1695+
}
1696+
},
1697+
"type": "object"
1698+
},
15411699
"Location": {
15421700
"description": "A resource that represents a Google Cloud location.",
15431701
"id": "Location",
@@ -1831,6 +1989,50 @@ false
18311989
},
18321990
"type": "object"
18331991
},
1992+
"PrimaryBackupPolicy": {
1993+
"description": "Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.",
1994+
"id": "PrimaryBackupPolicy",
1995+
"properties": {
1996+
"backupGeoTargets": {
1997+
"$ref": "GeoPolicy",
1998+
"description": "Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy."
1999+
},
2000+
"primaryTargets": {
2001+
"$ref": "HealthCheckTargets",
2002+
"description": "Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`."
2003+
},
2004+
"trickleTraffic": {
2005+
"description": "When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.",
2006+
"format": "double",
2007+
"type": "number"
2008+
}
2009+
},
2010+
"type": "object"
2011+
},
2012+
"RRSetRoutingPolicy": {
2013+
"description": "A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection.",
2014+
"id": "RRSetRoutingPolicy",
2015+
"properties": {
2016+
"geo": {
2017+
"$ref": "GeoPolicy"
2018+
},
2019+
"geoPolicy": {
2020+
"$ref": "GeoPolicy",
2021+
"deprecated": true
2022+
},
2023+
"primaryBackup": {
2024+
"$ref": "PrimaryBackupPolicy"
2025+
},
2026+
"wrr": {
2027+
"$ref": "WrrPolicy"
2028+
},
2029+
"wrrPolicy": {
2030+
"$ref": "WrrPolicy",
2031+
"deprecated": true
2032+
}
2033+
},
2034+
"type": "object"
2035+
},
18342036
"RegisterDomainRequest": {
18352037
"description": "Request for the `RegisterDomain` method.",
18362038
"id": "RegisterDomainRequest",
@@ -2182,6 +2384,62 @@ false
21822384
"properties": {},
21832385
"type": "object"
21842386
},
2387+
"ResourceRecordSet": {
2388+
"description": "A unit of data that is returned by the DNS servers.",
2389+
"id": "ResourceRecordSet",
2390+
"properties": {
2391+
"name": {
2392+
"description": "For example, www.example.com.",
2393+
"type": "string"
2394+
},
2395+
"routingPolicy": {
2396+
"$ref": "RRSetRoutingPolicy",
2397+
"description": "Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution)."
2398+
},
2399+
"rrdata": {
2400+
"description": "As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.",
2401+
"items": {
2402+
"type": "string"
2403+
},
2404+
"type": "array"
2405+
},
2406+
"signatureRrdata": {
2407+
"description": "As defined in RFC 4034 (section 3.2).",
2408+
"items": {
2409+
"type": "string"
2410+
},
2411+
"type": "array"
2412+
},
2413+
"ttl": {
2414+
"description": "Number of seconds that this `ResourceRecordSet` can be cached by resolvers.",
2415+
"format": "int32",
2416+
"type": "integer"
2417+
},
2418+
"type": {
2419+
"description": "The identifier of a supported record type. See the list of Supported DNS record types.",
2420+
"type": "string"
2421+
}
2422+
},
2423+
"type": "object"
2424+
},
2425+
"RetrieveGoogleDomainsDnsRecordsResponse": {
2426+
"description": "Response for the `RetrieveGoogleDomainsDnsRecords` method.",
2427+
"id": "RetrieveGoogleDomainsDnsRecordsResponse",
2428+
"properties": {
2429+
"nextPageToken": {
2430+
"description": "When present, there are more results to retrieve. Set `page_token` to this value on a subsequent call to get the next page of results.",
2431+
"type": "string"
2432+
},
2433+
"rrset": {
2434+
"description": "The resource record set resources (DNS Zone records).",
2435+
"items": {
2436+
"$ref": "ResourceRecordSet"
2437+
},
2438+
"type": "array"
2439+
}
2440+
},
2441+
"type": "object"
2442+
},
21852443
"RetrieveGoogleDomainsForwardingConfigResponse": {
21862444
"description": "Response for the `RetrieveGoogleDomainsForwardingConfig` method.",
21872445
"id": "RetrieveGoogleDomainsForwardingConfigResponse",
@@ -2438,6 +2696,48 @@ false
24382696
}
24392697
},
24402698
"type": "object"
2699+
},
2700+
"WrrPolicy": {
2701+
"description": "Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.",
2702+
"id": "WrrPolicy",
2703+
"properties": {
2704+
"item": {
2705+
"items": {
2706+
"$ref": "WrrPolicyItem"
2707+
},
2708+
"type": "array"
2709+
}
2710+
},
2711+
"type": "object"
2712+
},
2713+
"WrrPolicyItem": {
2714+
"description": "A routing block which contains the routing information for one WRR item.",
2715+
"id": "WrrPolicyItem",
2716+
"properties": {
2717+
"healthCheckedTargets": {
2718+
"$ref": "HealthCheckTargets",
2719+
"description": "Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set."
2720+
},
2721+
"rrdata": {
2722+
"items": {
2723+
"type": "string"
2724+
},
2725+
"type": "array"
2726+
},
2727+
"signatureRrdata": {
2728+
"description": "DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item.",
2729+
"items": {
2730+
"type": "string"
2731+
},
2732+
"type": "array"
2733+
},
2734+
"weight": {
2735+
"description": "The weight corresponding to this `WrrPolicyItem` object. When multiple `WrrPolicyItem` objects are configured, the probability of returning an `WrrPolicyItem` object's data is proportional to its weight relative to the sum of weights configured for all items. This weight must be non-negative.",
2736+
"format": "double",
2737+
"type": "number"
2738+
}
2739+
},
2740+
"type": "object"
24412741
}
24422742
},
24432743
"servicePath": "",

0 commit comments

Comments
 (0)