@googleapis/dns 2.0.0 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1.ts CHANGED
@@ -143,7 +143,7 @@ export namespace dns_v1 {
143
143
  }
144
144
 
145
145
  /**
146
- * A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
146
+ * A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the `ResourceRecordSets` in a `ManagedZone`. The current state of the `ManagedZone` is the sum effect of applying all `Change` elements in the `Changes` collection in sequence.
147
147
  */
148
148
  export interface Schema$Change {
149
149
  /**
@@ -180,13 +180,12 @@ export namespace dns_v1 {
180
180
  * The requested changes.
181
181
  */
182
182
  changes?: Schema$Change[];
183
- header?: Schema$ResponseHeader;
184
183
  /**
185
184
  * Type of resource.
186
185
  */
187
186
  kind?: string | null;
188
187
  /**
189
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a "snapshot" of collections larger than the maximum page size.
188
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
190
189
  */
191
190
  nextPageToken?: string | null;
192
191
  }
@@ -254,13 +253,12 @@ export namespace dns_v1 {
254
253
  * The requested resources.
255
254
  */
256
255
  dnsKeys?: Schema$DnsKey[];
257
- header?: Schema$ResponseHeader;
258
256
  /**
259
257
  * Type of resource.
260
258
  */
261
259
  kind?: string | null;
262
260
  /**
263
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
261
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
264
262
  */
265
263
  nextPageToken?: string | null;
266
264
  }
@@ -531,13 +529,12 @@ export namespace dns_v1 {
531
529
  kind?: string | null;
532
530
  }
533
531
  export interface Schema$ManagedZoneOperationsListResponse {
534
- header?: Schema$ResponseHeader;
535
532
  /**
536
533
  * Type of resource.
537
534
  */
538
535
  kind?: string | null;
539
536
  /**
540
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
537
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
541
538
  */
542
539
  nextPageToken?: string | null;
543
540
  /**
@@ -559,7 +556,7 @@ export namespace dns_v1 {
559
556
  deactivateTime?: string | null;
560
557
  kind?: string | null;
561
558
  /**
562
- * The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project\}/global/networks/{network\}
559
+ * The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project\}/global/networks/{network\}`
563
560
  */
564
561
  networkUrl?: string | null;
565
562
  }
@@ -584,7 +581,7 @@ export namespace dns_v1 {
584
581
  export interface Schema$ManagedZonePrivateVisibilityConfigNetwork {
585
582
  kind?: string | null;
586
583
  /**
587
- * The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project\}/global/networks/{network\}
584
+ * The fully qualified URL of the VPC network to bind to. Format this URL like `https://www.googleapis.com/compute/v1/projects/{project\}/global/networks/{network\}`
588
585
  */
589
586
  networkUrl?: string | null;
590
587
  }
@@ -608,12 +605,11 @@ export namespace dns_v1 {
608
605
  deletionTime?: string | null;
609
606
  kind?: string | null;
610
607
  /**
611
- * The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project\}/locations/{location\}/namespaces/{namespace\}
608
+ * The fully qualified URL of the namespace associated with the zone. Format must be `https://servicedirectory.googleapis.com/v1/projects/{project\}/locations/{location\}/namespaces/{namespace\}`
612
609
  */
613
610
  namespaceUrl?: string | null;
614
611
  }
615
612
  export interface Schema$ManagedZonesListResponse {
616
- header?: Schema$ResponseHeader;
617
613
  /**
618
614
  * Type of resource.
619
615
  */
@@ -623,7 +619,7 @@ export namespace dns_v1 {
623
619
  */
624
620
  managedZones?: Schema$ManagedZone[];
625
621
  /**
626
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
622
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
627
623
  */
628
624
  nextPageToken?: string | null;
629
625
  }
@@ -682,13 +678,12 @@ export namespace dns_v1 {
682
678
  oldValue?: Schema$ManagedZone;
683
679
  }
684
680
  export interface Schema$PoliciesListResponse {
685
- header?: Schema$ResponseHeader;
686
681
  /**
687
682
  * Type of resource.
688
683
  */
689
684
  kind?: string | null;
690
685
  /**
691
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
686
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
692
687
  */
693
688
  nextPageToken?: string | null;
694
689
  /**
@@ -697,11 +692,9 @@ export namespace dns_v1 {
697
692
  policies?: Schema$Policy[];
698
693
  }
699
694
  export interface Schema$PoliciesPatchResponse {
700
- header?: Schema$ResponseHeader;
701
695
  policy?: Schema$Policy;
702
696
  }
703
697
  export interface Schema$PoliciesUpdateResponse {
704
- header?: Schema$ResponseHeader;
705
698
  policy?: Schema$Policy;
706
699
  }
707
700
  /**
@@ -768,7 +761,7 @@ export namespace dns_v1 {
768
761
  networkUrl?: string | null;
769
762
  }
770
763
  /**
771
- * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console. Next tag: 7.
764
+ * A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
772
765
  */
773
766
  export interface Schema$Project {
774
767
  /**
@@ -805,6 +798,7 @@ export namespace dns_v1 {
805
798
  * Maximum allowed number of GKE clusters per response policy.
806
799
  */
807
800
  gkeClustersPerResponsePolicy?: number | null;
801
+ internetHealthChecksPerManagedZone?: number | null;
808
802
  /**
809
803
  * Maximum allowed number of items per routing policy.
810
804
  */
@@ -897,7 +891,7 @@ export namespace dns_v1 {
897
891
  */
898
892
  name?: string | null;
899
893
  /**
900
- * 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).
894
+ * 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).
901
895
  */
902
896
  routingPolicy?: Schema$RRSetRoutingPolicy;
903
897
  /**
@@ -909,7 +903,7 @@ export namespace dns_v1 {
909
903
  */
910
904
  signatureRrdatas?: string[] | null;
911
905
  /**
912
- * Number of seconds that this ResourceRecordSet can be cached by resolvers.
906
+ * Number of seconds that this `ResourceRecordSet` can be cached by resolvers.
913
907
  */
914
908
  ttl?: number | null;
915
909
  /**
@@ -919,13 +913,12 @@ export namespace dns_v1 {
919
913
  }
920
914
  export interface Schema$ResourceRecordSetsDeleteResponse {}
921
915
  export interface Schema$ResourceRecordSetsListResponse {
922
- header?: Schema$ResponseHeader;
923
916
  /**
924
917
  * Type of resource.
925
918
  */
926
919
  kind?: string | null;
927
920
  /**
928
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even larger collections, one page at a time. However, if the collection changes between paginated list requests, the set of elements returned is an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
921
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
929
922
  */
930
923
  nextPageToken?: string | null;
931
924
  /**
@@ -933,19 +926,9 @@ export namespace dns_v1 {
933
926
  */
934
927
  rrsets?: Schema$ResourceRecordSet[];
935
928
  }
936
- /**
937
- * Elements common to every response.
938
- */
939
- export interface Schema$ResponseHeader {
940
- /**
941
- * For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
942
- */
943
- operationId?: string | null;
944
- }
945
929
  export interface Schema$ResponsePoliciesListResponse {
946
- header?: Schema$ResponseHeader;
947
930
  /**
948
- * The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
931
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
949
932
  */
950
933
  nextPageToken?: string | null;
951
934
  /**
@@ -954,11 +937,9 @@ export namespace dns_v1 {
954
937
  responsePolicies?: Schema$ResponsePolicy[];
955
938
  }
956
939
  export interface Schema$ResponsePoliciesPatchResponse {
957
- header?: Schema$ResponseHeader;
958
940
  responsePolicy?: Schema$ResponsePolicy;
959
941
  }
960
942
  export interface Schema$ResponsePoliciesUpdateResponse {
961
- header?: Schema$ResponseHeader;
962
943
  responsePolicy?: Schema$ResponsePolicy;
963
944
  }
964
945
  /**
@@ -1001,7 +982,7 @@ export namespace dns_v1 {
1001
982
  export interface Schema$ResponsePolicyNetwork {
1002
983
  kind?: string | null;
1003
984
  /**
1004
- * The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project\}/global/networks/{network\}
985
+ * The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project\}/global/networks/{network\}`
1005
986
  */
1006
987
  networkUrl?: string | null;
1007
988
  }
@@ -1034,9 +1015,8 @@ export namespace dns_v1 {
1034
1015
  localDatas?: Schema$ResourceRecordSet[];
1035
1016
  }
1036
1017
  export interface Schema$ResponsePolicyRulesListResponse {
1037
- header?: Schema$ResponseHeader;
1038
1018
  /**
1039
- * The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
1019
+ * This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size.
1040
1020
  */
1041
1021
  nextPageToken?: string | null;
1042
1022
  /**
@@ -1045,11 +1025,9 @@ export namespace dns_v1 {
1045
1025
  responsePolicyRules?: Schema$ResponsePolicyRule[];
1046
1026
  }
1047
1027
  export interface Schema$ResponsePolicyRulesPatchResponse {
1048
- header?: Schema$ResponseHeader;
1049
1028
  responsePolicyRule?: Schema$ResponsePolicyRule;
1050
1029
  }
1051
1030
  export interface Schema$ResponsePolicyRulesUpdateResponse {
1052
- header?: Schema$ResponseHeader;
1053
1031
  responsePolicyRule?: Schema$ResponsePolicyRule;
1054
1032
  }
1055
1033
  /**
@@ -1057,12 +1035,16 @@ export namespace dns_v1 {
1057
1035
  */
1058
1036
  export interface Schema$RRSetRoutingPolicy {
1059
1037
  geo?: Schema$RRSetRoutingPolicyGeoPolicy;
1038
+ /**
1039
+ * The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
1040
+ */
1041
+ healthCheck?: string | null;
1060
1042
  kind?: string | null;
1061
1043
  primaryBackup?: Schema$RRSetRoutingPolicyPrimaryBackupPolicy;
1062
1044
  wrr?: Schema$RRSetRoutingPolicyWrrPolicy;
1063
1045
  }
1064
1046
  /**
1065
- * Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
1047
+ * Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user.
1066
1048
  */
1067
1049
  export interface Schema$RRSetRoutingPolicyGeoPolicy {
1068
1050
  /**
@@ -1080,7 +1062,7 @@ export namespace dns_v1 {
1080
1062
  */
1081
1063
  export interface Schema$RRSetRoutingPolicyGeoPolicyGeoPolicyItem {
1082
1064
  /**
1083
- * 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.
1065
+ * 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.
1084
1066
  */
1085
1067
  healthCheckedTargets?: Schema$RRSetRoutingPolicyHealthCheckTargets;
1086
1068
  kind?: string | null;
@@ -1090,14 +1072,18 @@ export namespace dns_v1 {
1090
1072
  location?: string | null;
1091
1073
  rrdatas?: string[] | null;
1092
1074
  /**
1093
- * 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.
1075
+ * 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.
1094
1076
  */
1095
1077
  signatureRrdatas?: string[] | null;
1096
1078
  }
1097
1079
  /**
1098
- * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set.
1080
+ * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.
1099
1081
  */
1100
1082
  export interface Schema$RRSetRoutingPolicyHealthCheckTargets {
1083
+ /**
1084
+ * The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)
1085
+ */
1086
+ externalEndpoints?: string[] | null;
1101
1087
  /**
1102
1088
  * Configuration for internal load balancers to be health checked.
1103
1089
  */
@@ -1121,7 +1107,7 @@ export namespace dns_v1 {
1121
1107
  */
1122
1108
  loadBalancerType?: string | null;
1123
1109
  /**
1124
- * 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\} .
1110
+ * 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\}`.
1125
1111
  */
1126
1112
  networkUrl?: string | null;
1127
1113
  /**
@@ -1142,16 +1128,16 @@ export namespace dns_v1 {
1142
1128
  */
1143
1129
  export interface Schema$RRSetRoutingPolicyPrimaryBackupPolicy {
1144
1130
  /**
1145
- * 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.
1131
+ * 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.
1146
1132
  */
1147
1133
  backupGeoTargets?: Schema$RRSetRoutingPolicyGeoPolicy;
1148
1134
  kind?: string | null;
1149
1135
  /**
1150
- * 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.
1136
+ * 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`.
1151
1137
  */
1152
1138
  primaryTargets?: Schema$RRSetRoutingPolicyHealthCheckTargets;
1153
1139
  /**
1154
- * When serving state is PRIMARY, this field provides the option of sending a small percentage of the traffic to the backup targets.
1140
+ * When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets.
1155
1141
  */
1156
1142
  trickleTraffic?: number | null;
1157
1143
  }
@@ -1167,17 +1153,17 @@ export namespace dns_v1 {
1167
1153
  */
1168
1154
  export interface Schema$RRSetRoutingPolicyWrrPolicyWrrPolicyItem {
1169
1155
  /**
1170
- * 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.
1156
+ * 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.
1171
1157
  */
1172
1158
  healthCheckedTargets?: Schema$RRSetRoutingPolicyHealthCheckTargets;
1173
1159
  kind?: string | null;
1174
1160
  rrdatas?: string[] | null;
1175
1161
  /**
1176
- * 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.
1162
+ * 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.
1177
1163
  */
1178
1164
  signatureRrdatas?: string[] | null;
1179
1165
  /**
1180
- * 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.
1166
+ * 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.
1181
1167
  */
1182
1168
  weight?: number | null;
1183
1169
  }